Improve sysvar documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 617
- Forks
- 724
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 223
Description
Change Request
This repository is ONLY used to solve issues related to DOCS.
For other issues (related to TiDB, PD, etc), please move to other repositories.
Please answer the following questions before submitting your issue. Thanks!
- Describe what you find is inappropriate or missing in the existing docs.
In the PR https://github.com/pingcap/docs/pull/3152 the following comments were left unhandled:
- Has the value of
autobeen removed fromtidb_enable_table_partition? @tiancaiamao - Can we safely set tidb_row_format_version to a lower value in a newer versioned TiDB cluster? @coocood
- Is there an example where
windowing_use_high_precisionhas different behavior / performance? @SunRunAway
- Describe your suggestion or addition.
See above.
- Provide some reference materials (documents, websites, etc) if you could.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading PR 3152 and the unresolved comments about tidb_enable_table_partition, tidb_row_format_version, and windowing_use_high_precision. Locate those system-variable entries in the documentation, verify the behavior and version or performance details, and update the relevant explanations and examples so all three questions are answered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100