Revamp the README and the generated docs#190
Merged
bastelfreak merged 11 commits intovoxpupuli:masterfrom Feb 13, 2021
Merged
Conversation
added 10 commits
February 13, 2021 08:58
Contributor
Author
cschug
added a commit
to cschug/pypuppetdb
that referenced
this pull request
Jul 14, 2022
With PR voxpupuli#190 documentation files were renamed (.rst to .md).
This file contains hidden or 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
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.

I have updated this projects docs in a similar style to voxpupuli/puppetboard#601 . The main changes are:
Moved the user guide out of the README and into the
/docsso it will be served from readthedocs.io,Reorganized the docs into 3 main sections: user guide, connecting from other hosts than the puppetdb's, developer guide,
Changed the docs theme to a more modern one - the one used by https://toolbelt.readthedocs.io , for example,
Cleaned up and updated the README,
Changed the format of the README and changelog from RST to Markdown, to make them for friendly to contributors,
Moved the contributing guide into a separate file and updated it,