pingcap / pingcap/docs-cn

Improve related documentation for stale/strong read and relative operation in cloud

Open
#10,927 1 comment 1 reaction 1 assignee View on GitHub

Nobody has claimed this yet.

area/scheduling tracked type/enhancement type/refactor
Dominant language
Python
Stars
1.8k
Forks
1.2k
Avg merge
1d 16h
Merged PRs (30d)
31

Description

Change Request

This repository is ONLY used to solve problems related to DOCS-CN.
For other issues (TiDB, TiKV, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!

  1. Describe what you find is inappropriate or missing in the existing docs.

Currently, the document about Stale Read and follower read is not friendly to users:

  • Missing the docs about the session variables. such as closest-replicas
  • Missing the docs on how to use it in the cluster deployed by tidb-operator.
  • The featureStale Read and Follower Read do not describe at the same level. should be Stale vs Strong, Leader vs Follower.
  1. Describe your suggestion or addition.

I will change relative documents.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.