Initialize docs repository #1
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
This commit changes the README from the template repository's README to a more specific README to the FOSSRIT Runbook. I also set up and added badges for TravisCI and ReadTheDocs.org. Additionally, I changed the license from the BSD 3-Clause License to a Creative Commons license, which makes more sense since this repo mostly deals with content, not code. Signed-off-by: Justin W. Flory <[email protected]>
This commit adds contributing guidelines that explain how to write documentation (i.e. style guide) and also how to build/test the documentation. It also sets some expectations about how best to get a change merged. Signed-off-by: Justin W. Flory <[email protected]>
This commit changes the Sphinx configuration file, build scripts, and docs index page to use the correct name for the FOSSRIT Runbook, as well as some other minor adjustments. These are mostly cosmetic, since the config options I prefer as a default came from the template repository, jwflory/sphinx-docs-opinionated-quickstart. Signed-off-by: Justin W. Flory <[email protected]>
Remove irrelevant example docs from the template repository. Future
commits will begin to add real content to the repo based on the
structure outlined here:
https://fossrit.community/t/request-for-comments-foss-rit-runbook/176
Signed-off-by: Justin W. Flory <[email protected]>
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.
Related to FOSSRIT/tasks#107.
This pull request includes a few commits to get things rolling:
a92db7e — 📝 Update README, change LICENSE to CC BY-SA 4.0
This commit changes the README from the template repository's README to
a more specific README to the FOSSRIT Runbook. I also set up and added
badges for TravisCI and ReadTheDocs.org.
Additionally, I changed the license from the BSD 3-Clause License to a
Creative Commons license, which makes more sense since this repo mostly
deals with content, not code.
b1d5ee0 — 💡 Add contributing guidelines
This commit adds contributing guidelines that explain how to write
documentation (i.e. style guide) and also how to build/test the
documentation. It also sets some expectations about how best to get a
change merged.
b10d728 — 🏷️ Update Sphinx configuration and build scripts
This commit changes the Sphinx configuration file, build scripts, and
docs index page to use the correct name for the FOSSRIT Runbook, as well
as some other minor adjustments. These are mostly cosmetic, since the
config options I prefer as a default came from the template repository,
jwflory/sphinx-docs-opinionated-quickstart.
6adbec5 — 🗑️ Remove unused example files
Remove irrelevant example docs from the template repository. Future
commits will begin to add real content to the repo based on the
structure outlined here:
https://fossrit.community/t/request-for-comments-foss-rit-runbook/176