Split README into multiple files #1320
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
Rename docs -> sample_data and move inside test/common folder for a more permanent place. We will use the docs folder for public repo documentation.
longrunningprocess
approved these changes
Mar 9, 2022
Other Resources is now a MD list
Yes, I pushed the PR quickly without taking the time to update the description. Done, thank you. |
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.
This PR splits the one long README into several files:
CONTRIBUTING.md
docs/ACKNOWLEDGEMENTS.md
docs/RELEASE.md
docs/DEVELOPER.md
It also moves the files in the former "docs" folder to a new folder called "sample_data", since that is what it actually is. The "docs" folder is an open-source repo convention used for various markdown files like I have put above. The CONTRIBUTING.md file is recognized by GitHub as a special file and will be displayed on the PR page.
A future PR will include more specific information on how to contribute.
Type of Change
Documentation update
Checklist