Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add more documentation #435

Open
rdunklau opened this issue Jul 27, 2021 · 0 comments
Open

Add more documentation #435

rdunklau opened this issue Jul 27, 2021 · 0 comments

Comments

@rdunklau
Copy link
Contributor

The current documentation is great as a reference for configuration parameters, but it would be better if we had more comprehensive documentation.

Since the project is in Python, it would make sense to use sphinx.

This issue is mostly here to aggregate various discussions that will arise when starting the documentation project.

Here is a first draft of a proposal for I'd like to see in the documentation:

  • About PGHoard:
    • What is it
    • Main features / unique features
    • Comparison with other tools
    • Caveats
  • Architecture
    • Describe the client / server architecture
    • List several common deployments pattern (same host ? centralized backup server ?)
  • Build / Install
  • Usage (including examples, basic and special)
  • Configuration
    • Backup
    • Archiving
    • Restoration
    • Expiration policies (examples)
  • How to monitor (alert files / replication slot / prometheus)
  • Contributing
    • Run from source
    • Tests
    • Internals : Storage / Compression / Encryption API specifications

I'll start working on a base structure and iterate from there.

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

No branches or pull requests

1 participant