Skip to content

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

Merged
ti-chi-bot[bot] merged 2 commits intopingcap:release-7.1from
qiancai:v7.1/update-links-for-new-nav
Feb 11, 2026
Merged

new nav release-7.1: remove develop guide, releases, and best practices from TOC.md#22404
ti-chi-bot[bot] merged 2 commits intopingcap:release-7.1from
qiancai:v7.1/update-links-for-new-nav

Conversation

@qiancai
Copy link
Copy Markdown
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

@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
Copy Markdown
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 significant reorganization of the documentation structure for TiDB release 7.1. The changes aim to improve the clarity and navigability of the documentation by removing outdated or less frequently accessed top-level sections, consolidating related content into new subdirectories, and meticulously updating all internal links to maintain consistency and a seamless user experience.

Highlights

  • Documentation Restructuring: Major sections such as 'Develop', 'Best Practices', and 'Release Notes' have been removed from the main Table of Contents (TOC.md) to streamline navigation for release 7.1.
  • File Relocation: Several key documentation files, including ddl-introduction.md, best-practices-on-public-cloud.md, and java-app-best-practices.md, have been moved into new, more logical subdirectories (best-practices/ and develop/).
  • Internal Link Updates: Numerous internal links across various documents (e.g., FAQ, performance tuning, SQL DDL, DXF, upgrade guide, telemetry) have been updated to reflect the new file paths and ensure all references remain valid.
  • TOC Entry Relocation: The 'TiDB Installation Packages' entry has been moved from the 'Release Notes' category to the 'References' category within the Table of Contents.

🧠 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-tidb-cloud.md
    • Updated the link for 'DDL Execution Principles and Best Practices' to reflect its new path under best-practices/.
  • TOC.md
    • Removed the entire 'Develop' section from the Table of Contents.
    • Removed 'TiDB Best Practices on Public Cloud' from the 'Performance Tuning' section.
    • Removed the entire 'Best Practices' section from the Table of Contents.
    • Removed the entire 'Release Notes' section from the Table of Contents.
    • Added 'TiDB Installation Packages' under the 'References' section.
  • best-practices-on-public-cloud.md
    • File renamed and moved to best-practices/best-practices-on-public-cloud.md.
  • best-practices/java-app-best-practices.md
    • File renamed and moved to develop/java-app-best-practices.md.
  • ddl-introduction.md
    • File renamed and moved to best-practices/ddl-introduction.md.
  • develop/dev-guide-connection-parameters.md
    • Updated an internal link to 'Best Practices for Developing Java Applications with TiDB' to its new path under develop/.
  • develop/dev-guide-optimize-sql-best-practices.md
    • Updated an internal link to 'Best Practices for Developing Java Applications with TiDB' to its new path under develop/.
  • faq/sql-faq.md
    • Updated an internal link for 'Execution Principles and Best Practices of DDL Statements' to its new path under best-practices/.
  • performance-tuning-practices.md
    • Updated an internal link to 'Best Practices for Developing Java Applications with TiDB' to its new path under develop/.
  • releases/release-7.0.0.md
    • Updated three internal links related to DDL documentation to their new path under best-practices/.
  • releases/release-7.1.0.md
    • Updated an internal link for 'Fast Online DDL' documentation to its new path under best-practices/.
  • sql-statements/sql-statement-admin-show-ddl.md
    • Updated an internal link for 'How the Online DDL Asynchronous Change Works in TiDB' to its new path under best-practices/.
  • telemetry.md
    • Updated the external link for 'release notes' to a new URL.
  • tidb-distributed-execution-framework.md
    • Updated an internal link for 'Execution Principles and Best Practices of DDL Statements' to its new path under best-practices/.
  • upgrade-tidb-using-tiup.md
    • Updated external links for 'Release Notes' to a new URL.
    • Updated an internal link for the 'concurrent DDL framework' to its new path under best-practices/.
Activity
  • No human activity (comments, reviews, etc.) has been recorded for this pull request yet.
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.

Copy link
Copy Markdown
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 involves a significant reorganization of the documentation, including moving files, updating links, and restructuring the table of contents. The changes are extensive and have been executed well, with all internal links updated to reflect the new file structure. My review found one minor opportunity for improvement in telemetry.md to better align with the repository's documentation style guide by using active voice.

Comment thread telemetry.md
@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. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. labels Feb 5, 2026
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented Feb 11, 2026

/approve

@ti-chi-bot ti-chi-bot Bot added the approved label Feb 11, 2026
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented Feb 11, 2026

/approve

1 similar comment
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented Feb 11, 2026

/approve

@qiancai qiancai added the lgtm label Feb 11, 2026
@qiancai
Copy link
Copy Markdown
Collaborator Author

qiancai commented Feb 11, 2026

/approve

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented Feb 11, 2026

[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 merged commit 0a10544 into pingcap:release-7.1 Feb 11, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved area/develop This PR relates to the area of TiDB App development. lgtm 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