2PC Doc needs revision
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Java
- Stars
- 70
- Forks
- 236
- Avg merge
- 5h 41m
- Merged PRs (30d)
- 9
Description
In #346 there are two pieces of review feedback:
- There isn't any WithAtomicity reference in the Vitess codebase outside of this document (an obvious out of date content piece).
- There are passive voice / readability issues.
I am merging #346 because the improvements are required ( a warning + instructions how to turn it on in SQL), but its clear this document needs more work.
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 locating the 2PC document and reviewing the changes and feedback in #346. Check the document for the outdated WithAtomicity reference and passive-voice or readability problems; done means the warning and SQL instructions remain accurate while those issues are revised.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100