couchbaselabs / couchbaselabs/docs-ng

Typo in 2-phase commit diagram?

Open
#175 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
14
Forks
28
PR merge metrics
No merged PRs in 30d

Description

I'm currently reading the doc for advanced topics in development and in the chapter about 2-phase commit, I'm a bit confused by the diagram that appears after this paragraph: "This next illustration shows you the diagram we initially introduced to you at the start of this section. but this we update it to show when system failures may occur and the rollback scenario you may want to provide. Depending on the programming language that you use, how you implement the rollbacks may vary slightly:"

In the 3rd line, the document for karen still has 500 points but transaction trans1 has been recorded. According to the code, this should not be possible. Should this stage show 400 points for Karen already?

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the advanced development topics chapter and inspect the 2-phase commit diagram after the quoted paragraph, focusing on its third line and Karen's points. Compare that state with the transaction and rollback behavior described in the surrounding text; it is done when the diagram consistently reflects the documented sequence.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.