apple / apple/foundationdb

Clarify replication configuration documentation

Open
#1,829 0 comments 0 reactions 0 assignees View on GitHub
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

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.