Skip to content

new nav release-6.5: remove develop guide, releases, and best practices from TOC.md#22405

Open
qiancai wants to merge 2 commits intopingcap:release-6.5from
qiancai:v6.5/update-links-for-new-nav
Open

new nav release-6.5: remove develop guide, releases, and best practices from TOC.md#22405
qiancai wants to merge 2 commits intopingcap:release-6.5from
qiancai:v6.5/update-links-for-new-nav

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 5, 2026

What is changed, added or deleted? (Required)

  • Removed doc entries for Develop/Best Practices/Release Notes
  • Moved TiDB Installation Packages from the Release Notes category to the References category
  • Moved files into best-practices/ and develop/ (ddl-introduction.md -> best-practices/, best-practices-on-public-cloud.md -> best-practices/, java-app-best-practices.md -> develop/).
  • Updated internal links in multiple docs (faq, performance-tuning-practices, SQL DDL docs, DXF doc, upgrade guide, telemetry) to point to the new paths.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 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)

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

github-actions bot and others added 2 commits November 12, 2025 06:27
Synced from: qiancai/docs-cn#15
Target PR: #3
AI Provider: gemini

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 5, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign ran-huang for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found 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 area/develop This PR relates to the area of TiDB App development. missing-translation-status This PR does not have translation status info. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 5, 2026
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @qiancai, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a substantial refactoring of the documentation's navigation and file structure. The changes aim to simplify the Table of Contents by consolidating related content under new, more logical groupings. This involves the removal of several high-level categories and the relocation of their associated files, along with comprehensive updates to all internal links to maintain the integrity and usability of the documentation.

Highlights

  • Documentation Restructuring: The Table of Contents (TOC.md) has undergone a significant reorganization, removing the 'Develop', 'Best Practices', and 'Release Notes' top-level sections to streamline navigation.
  • File Relocation: Several documentation files, such as ddl-introduction.md, best-practices-on-public-cloud.md, and java-app-best-practices.md, have been moved into new best-practices/ and develop/ subdirectories for better content organization.
  • Internal Link Updates: Numerous internal links across various documents, including FAQ, performance tuning guides, SQL DDL docs, and upgrade guides, have been updated to reflect the new file paths and ensure consistent navigation.
  • New System Variable: A new system variable, tidb_opt_selectivity_factor, has been introduced in system-variables.md, providing a default selectivity factor for the TiDB optimizer.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • TOC.md
    • Removed the entire 'Develop' section and its sub-entries.
    • Removed 'TiDB Best Practices on Public Cloud' from the 'Performance Tuning' section.
    • Removed the entire 'Best Practices' section and its sub-entries.
    • Removed 'DDL Execution Principles and Best Practices'.
    • Moved 'TiDB Installation Packages' from the 'Release Notes' category to the 'References' category.
    • Removed the entire 'Release Notes' section, including all version-specific entries.
  • best-practices-on-public-cloud.md
    • Renamed to best-practices/best-practices-on-public-cloud.md.
  • best-practices/java-app-best-practices.md
    • Renamed to develop/java-app-best-practices.md.
  • ddl-introduction.md
    • Renamed to best-practices/ddl-introduction.md.
  • develop/dev-guide-connection-parameters.md
    • Updated internal link from /best-practices/java-app-best-practices.md to /develop/java-app-best-practices.md.
  • develop/dev-guide-optimize-sql-best-practices.md
    • Updated internal link from /best-practices/java-app-best-practices.md to /develop/java-app-best-practices.md.
  • faq/sql-faq.md
    • Updated internal link from /ddl-introduction.md to /best-practices/ddl-introduction.md.
  • performance-tuning-practices.md
    • Updated internal link from /best-practices/java-app-best-practices.md to /develop/java-app-best-practices.md.
  • sql-statements/sql-statement-admin-show-ddl.md
    • Updated internal link from /ddl-introduction.md to /best-practices/ddl-introduction.md.
  • system-variables.md
    • Added a new system variable tidb_opt_selectivity_factor (Introduced in v9.0.0).
  • telemetry.md
    • Updated the external link for release notes from /releases/release-notes.md to https://docs.pingcap.com/releases/tidb-self-managed/.
  • upgrade-tidb-using-tiup.md
    • Updated the external link for release notes from /releases/release-notes.md to https://docs.pingcap.com/releases/tidb-self-managed/.
    • Updated internal link for the DDL framework from /ddl-introduction.md to /best-practices/ddl-introduction.md.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 5, 2026

@qiancai: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify ae24f5f link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Copy link
Contributor

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

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 primarily focuses on restructuring the documentation by removing the 'Develop', 'Best Practices', and 'Release Notes' sections from the main table of contents and updating internal links accordingly. The file moves and link updates appear to be correct and consistent with the PR's goal. However, there's an unrelated change in system-variables.md that introduces a new system variable but incorrectly places its documentation, which I've commented on.

Comment on lines +1795 to 1807
### `tidb_opt_selectivity_factor` <span class="version-mark">Introduced in v9.0.0</span>

- Scope: SESSION | GLOBAL
- Is persisted to the cluster: Yes
- Is controlled by Hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes
- Type: Floating-point number
- Value range: `[0, 1]`
- Default value: `0.8`
- This variable specifies the default selectivity factor for the TiDB optimizer. In some cases, when the optimizer cannot derive the predicate selectivity based on statistics, the optimizer uses this default selectivity as a substitute. **It is not recommended** to modify this value.

- Persists to cluster: Yes
- Type: Boolean
- Default value: `OFF`
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

There seems to be a structural issue here. The documentation for the new system variable tidb_opt_selectivity_factor has been inserted in the middle of the properties list for tidb_enable_pseudo_for_outdated_stats. This breaks the document's structure and readability.

The new section for tidb_opt_selectivity_factor should be placed after the entire section for tidb_enable_pseudo_for_outdated_stats is complete. The properties for tidb_enable_pseudo_for_outdated_stats should be grouped together, followed by its description.

Also, this change seems unrelated to the main purpose of this pull request. It might be better to move this change to a separate PR.

@qiancai qiancai added the type/refactor The issue belongs to a refactor work. label Feb 5, 2026
@qiancai qiancai self-assigned this Feb 5, 2026
@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. and removed missing-translation-status This PR does not have translation status info. labels Feb 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/refactor The issue belongs to a refactor work.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant