WordPress / WordPress/openverse
Add instructions for testing migrations for zero-downtime compatibility to docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 380
- Forks
- 290
- Avg merge
- 3h 17m
- Merged PRs (30d)
- 8
Description
Problem
In a PR like https://github.com/WordPress/openverse/pull/956, where a column is being removed that has non-obvious usages, it's easy to have false confidence that the change is compatible with zero-downtime deployments. Luckily, there is a way to confirm via manual testing whether a migration works with zero-downtime, as described in this review comment: https://github.com/WordPress/openverse/pull/956#pullrequestreview-1353526516
Description
Add instructions for testing a migration for zero-downtime compatibility to the zero-downtime documentation. Add a link to that section of the documentation to the migration check comment so that folks are always aware of the method when they're dealing with a PR with migrations.
Contributor guide
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 with the zero-downtime documentation and the migration check comment referenced in the issue, then review PR #956 for the manual testing method. Add the testing instructions to the zero-downtime section and link that section from the migration check comment so migration authors can find it.
Written by the indexing model from the issue text.
Assessment
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100