Skip to content

Revamp the README and the generated docs#190

Merged
bastelfreak merged 11 commits intovoxpupuli:masterfrom
gdubicki:revamp_readme
Feb 13, 2021
Merged

Revamp the README and the generated docs#190
bastelfreak merged 11 commits intovoxpupuli:masterfrom
gdubicki:revamp_readme

Conversation

@gdubicki
Copy link
Contributor

@gdubicki gdubicki commented Feb 13, 2021

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 /docs so 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,

    • Unfortunately I don't have the knowledge to update the developer guide one, so I added a warning that it may be out of date,
  • 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,

    • Removed the info about the native packages from the README as they either don't exist or are outdated + removed the outdated .spec files,
  • 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,

@gdubicki
Copy link
Contributor Author

This is how the docs will look:
Screenshot 2021-02-13 at 11 43 22

@gdubicki gdubicki marked this pull request as ready for review February 13, 2021 10:47
@bastelfreak bastelfreak merged commit d3003ff into voxpupuli:master Feb 13, 2021
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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants