Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

First draft of developer docs #491

merged 1 commit into from Feb 28, 2022


Copy link

@dnephin dnephin commented Feb 25, 2022

These are some notes I wrote while learning how raft works. These docs form a kind of domain model for raft.

The docs can be viewed in github, here's a preview.

Some of the things I found to be particularly valuable are:

  • the sequence diagram in
  • an easily discoverable, and comprehensive definition for things like "Applied", and "Committed"
  • a list of the threads, and their responsibilities , which can be mapped back to high level operations

Still lots of detail that could be added.
@dnephin dnephin merged commit e76e6e4 into hashicorp:main Feb 28, 2022
@dnephin dnephin deleted the dnephin/add-dev-docs branch February 28, 2022 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

2 participants