apple / apple/foundationdb

Update documentation to reflect new roles

Open
#2,501 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

The [architecture](https://github.com/apple/foundationdb/blob/master/documentation/sphinx/source/kv-architecture.rst) page is a bit outdated.

- Missing new roles
- I think Log router is the only new role that's not there
- Still assumes data distributor and rate keeper are part of the master

Contributor guide

Open the contributing guide

Research direction

Open documentation/sphinx/source/kv-architecture.rst and compare its listed roles and master responsibilities with the current architecture. Update the page to include the Log router and stop describing the data distributor and rate keeper as part of the master; no test is specified, so completion is verified by reviewing the rendered documentation.

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
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.