pingcap / pingcap/docs-tidb-operator

Add a FAQ about why TiDB Operator deploys TiDB as a StatefulSet instead of deployment

Open
#1,350 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
52
Forks
129
Avg merge
12m
Merged PRs (30d)
2

Description

Change Request

This repository is ONLY used to solve issues related to TiDB Operator documentation.
For other issues (related to TiDB, PD, etc), please move to other repositories.

Please answer the following questions before submitting your issue. Thanks!
https://docs.pingcap.com/zh/tidb-in-kubernetes/dev/faq

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

  2. Describe your suggestion or addition.

  3. Provide some reference materials (documents, websites, etc) if you could.

Contributor guide

No contributing guide indexed for this repository

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 the existing FAQ at https://docs.pingcap.com/zh/tidb-in-kubernetes/dev/faq and review how its questions and answers are structured. Add a FAQ entry explaining why TiDB Operator deploys TiDB as a StatefulSet rather than a Deployment, with enough context for documentation readers to understand the choice.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.