Skip to content

config: fix heading hierarchy for sub-section levels in tidb-configuration-file.md#23160

Merged
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
yahonda:fix-config-heading-hierarchy
Jun 29, 2026
Merged

config: fix heading hierarchy for sub-section levels in tidb-configuration-file.md#23160
ti-chi-bot[bot] merged 2 commits into
pingcap:release-8.5from
yahonda:fix-config-heading-hierarchy

Conversation

@yahonda

@yahonda yahonda commented Jun 29, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Fix heading hierarchy in tidb-configuration-file.md for sub-section levels that incorrectly used ## instead of ###:

  • ## log.file### log.file (child of ## log)
  • ## opentracing.sampler### opentracing.sampler (child of ## opentracing)
  • ## opentracing.reporter### opentracing.reporter (child of ## opentracing)
  • ## tikv-client.copr-cache### tikv-client.copr-cache (child of ## tikv-client)

These dotted config key names indicate they belong to parent sections, so they should be rendered as sub-headings.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Change sub-section headings from ## to ### to properly reflect
the config key hierarchy:

- ## log.file → ### log.file (child of ## log)
- ## opentracing.sampler → ### opentracing.sampler
- ## opentracing.reporter → ### opentracing.reporter
- ## tikv-client.copr-cache → ### tikv-client.copr-cache

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adjusts several section headings in tidb-configuration-file.md (specifically log.file, opentracing.sampler, opentracing.reporter, and tikv-client.copr-cache) from H2 (##) to H3 (###) to improve the document structure. The review feedback points out that while these changes are correct, the nested configuration options under opentracing.sampler, opentracing.reporter, and tikv-client.copr-cache are still using H3 (###) headings and should be updated to H4 (####) to maintain a proper heading hierarchy.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread tidb-configuration-file.md
Comment thread tidb-configuration-file.md
Comment thread tidb-configuration-file.md
@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 29, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-06-29 10:47:08.670362932 +0000 UTC m=+36370.370742345: ☑️ agreed by qiancai.

@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 29, 2026
@qiancai qiancai self-assigned this Jun 29, 2026
@qiancai qiancai added translation/doing This PR's assignee is translating this PR. needs-cherry-pick-master Should cherry pick this PR to master branch. labels Jun 29, 2026
@qiancai

qiancai commented Jun 29, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Jun 29, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 29, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the approved label Jun 29, 2026
github-actions Bot added a commit to qiancai/docs-cn that referenced this pull request Jun 29, 2026
Synced from: pingcap/docs#23160
Target PR: pingcap#21748
AI Provider: azure

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ti-chi-bot ti-chi-bot Bot merged commit b1a157c into pingcap:release-8.5 Jun 29, 2026
11 checks passed
@ti-chi-bot

Copy link
Copy Markdown
Member

In response to a cherrypick label: new pull request created to branch master: #23167.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-master Should cherry pick this PR to master branch. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants