Remove extra info from readme. #1673
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can we add some mention of the wiki? This is one of the two repos in our org that has an active wiki we use for stuff. "Additional resources and information about community meetings is available in wiki" or something to that effect? |
manez
reviewed
Nov 9, 2020
README.md
Outdated
|
|
||
| This repository contains the user, developer, and administrator documentation for the [Islandora project](https://islandora.ca/), for versions 8 and above. This documentation is available to read at https://islandora.github.io/documentation/, where it is automatically deployed on commit from the source code at https://github.com/Islandora/documentation. Documentation for Islandora 7.x and previous versions is available at https://wiki.lyrasis.org/display/ISLANDORA/. | ||
| ## About the Documentation |
There was a problem hiding this comment.
I can't seem to manage a pull request against your fork, but I do have some wording here to roll in @eldonquijote 's suggestion:
## About the Documentation
This repository has three primary uses:
- it contains source code for the user, developer, and administrator documentation for versions 8.x and above of the [Islandora project](https://islandora.ca/). It is written in mkdocs and can be viewed on [our Github Pages site](https://islandora.github.io/documentation/).
- its [Wiki](https://github.com/Islandora/documentation/wiki) contains the minutes for Islandora 8 Tech calls and User calls.
- it hosts the central [issue queue](https://github.com/Islandora/documentation/issues) for the entire Islandora 8 project.
There was a problem hiding this comment.
I made a couple changes for brevity - does it still work?
|
Tagging @jrubin6 since he is name-dropped in the PR too :) |
manez
approved these changes
Nov 13, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose / why
The readme was like a mini documentation about the Islandora project. I streamlined it and tried to redirect viewers to the github pages.
What changes were made?
Removed the submodules bit, and the section where they were described as part of "this repository's structure".
I took out A LOT that was islandora-related:
Verification
Please comment if you think that some of this needs to be back in, in one form or another!
Interested Parties
@manez @dannylamb @eldonquijote (Jeff Rubin?)
Checklist