PITR documentation is scattered across many pages
Open
Nobody has claimed this yet.
documentation
- Dominant language
- CSS
- Stars
- 2
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
- https://pigsty.io/docs/pig/pitr/
- https://pigsty.io/docs/concept/pitr/#recovery
- https://pigsty.io/docs/pgsql/backup/#quick-start
Having 3 commands (pig pitr, ./pgsql-pitr.yml and pg-pitr) for the same purpose but with different interface and caveats is confusing and not friendly for new users, more so when the documentation for each is mostly standalone and separate from each other.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the three referenced pages: /docs/pig/pitr/, /docs/concept/pitr/#recovery, and /docs/pgsql/backup/#quick-start. Document how pig pitr, ./pgsql-pitr.yml, and pg-pitr differ, then consolidate the PITR guidance so new users can choose the appropriate interface and understand its caveats in one coherent place.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100