rethinkdb / rethinkdb/docs

Clarify soft durability explanation in troubleshooting

Open
#1,048 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

http://www.rethinkdb.com/docs/troubleshooting/ currently says:

In soft durability mode RethinkDB will acknowledge the write immediately after receiving it, but before the write has been committed to disk.

The meaning of this is a bit unclear in a clustered environment (compare https://github.com/rethinkdb/rethinkdb/issues/5510 ). Each individual replica will acknowledge the write to the server executing the query immediately and before writing it to disk, but the query itself will still only get acknowledged to the client once it has reached a majority of servers.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the troubleshooting page at http://www.rethinkdb.com/docs/troubleshooting/ and review the quoted soft-durability explanation alongside issue #5510. Clarify how acknowledgements work for individual replicas and for the client in a clustered environment, then verify that the revised text is accurate and readable on the page.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.