Aiven-Open / Aiven-Open/pghoard

Add more documentation

Aberta
#435 0 comentários 5 reações 0 responsáveis Ver no GitHub
Linguagem predominante
Python
Estrelas
1.4k
Forks
111
Merge médio
1d 5h
PRs com merge (30d)
2

Descrição

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.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.