Clarify replication configuration documentation
- Dominant language
- C++
- Stars
- 16.7k
- Forks
- 1.6k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 126
Description
https://forums.foundationdb.org/t/locking-coordination-state-after-process-removal/1512/5 nicely explains how the phrasing in https://apple.github.io/foundationdb/configuration.html#single-datacenter-modes could be interpreted in unintended ways. We should find some less misinterpretable text to use, most of which has already been suggested in the forum post.
Contributor guide
Research direction
Read the single-datacenter modes section of configuration.html and the linked forum discussion, especially the suggested replacement wording. Revise the replication configuration text so its meaning cannot be interpreted in the unintended way described there, then verify the rendered documentation communicates the intended behavior.
Written by the indexing model from the issue text.
Assessment
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100