pingcap / pingcap/docs

Let's not mention `RAFT` here

Open
#13,072 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

The raft here brings a lot of confusion to the audience. People might think about the raft engine.

File: /release-6.6/partitioned-raft-kv.md

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 release-6.6/partitioned-raft-kv.md, linked in the issue. Read the surrounding text where RAFT is mentioned and revise the wording so it no longer creates confusion with the raft engine; the documentation is done when that ambiguity is removed.

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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.