Skip to content

new nav: minor fixes for developer guides#22411

Merged
qiancai merged 9 commits intopingcap:feature/preview-top-navigationfrom
qiancai:developer-doc-updates
Feb 6, 2026
Merged

new nav: minor fixes for developer guides#22411
qiancai merged 9 commits intopingcap:feature/preview-top-navigationfrom
qiancai:developer-doc-updates

Conversation

@qiancai
Copy link
Collaborator

@qiancai qiancai commented Feb 5, 2026

What is changed, added or deleted? (Required)

Make the following documentation fixes and clarifications across several develop guides:

  • develop/dev-guide-connection-parameters.md: add a Tip block and reference related Java best-practices sections.
  • develop/dev-guide-delete-data.md: reformat the DATETIME/TIMESTAMP note into list items and clarify the year-2038 recommendation.
  • develop/dev-guide-get-data-from-single-table.md: fix code typo (conn.createStatement) and update the referenced JDBC sample doc link.
  • develop/dev-guide-insert-data.md: standardize bulk-import/export wording and replace external links with internal documentation pages for Dumpling, TiDB Cloud import/export, DM, and BR.
  • develop/dev-guide-third-party-tools-compatibility.md: clarify guidance about avoiding server status variables and point to monitoring docs for TiDB Cloud and self-managed setups.
  • develop/dev-guide-use-follower-read.md: clarify Key Visualizer steps for TiDB Cloud and self-managed dashboards and add a pointer to hotspot troubleshooting guidance.

These edits improve accuracy, consistency, and navigation between related docs.

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/M Denotes a PR that changes 30-99 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 series of minor yet impactful documentation fixes across several developer guides. The primary goal is to enhance the overall quality, accuracy, and user experience of the documentation by standardizing language, correcting minor errors, clarifying complex topics, and improving internal linking. These changes ensure that developers can more easily understand and navigate the TiDB documentation, leading to a smoother development experience.

Highlights

  • Documentation Clarity and Consistency: Multiple developer guides have been updated to improve accuracy, standardize terminology, and enhance navigation between related documentation pages.
  • Java Application Development Guides: The 'Connection Parameters' guide now includes a 'Tip' block referencing key sections from Java best practices, and a typo in conn.createStatus() was corrected to conn.createStatement() in the 'Get Data from Single Table' guide.
  • Data Management Tools: The 'Insert Data' guide has standardized wording for bulk-import/export tools and updated external links to point to internal documentation for Dumpling, TiDB Cloud import/export, DM, and BR.
  • Monitoring and Troubleshooting: Guidance on avoiding MySQL server status variables for monitoring has been clarified, with updated links to TiDB Cloud and Self-Managed monitoring documentation. Key Visualizer steps for hotspot analysis in 'Use Follower Read' have also been refined.
  • Date/Time Type Clarification: The 'Delete Data' guide now presents the DATETIME/TIMESTAMP note as a bulleted list, clarifying the year-2038 recommendation for TIMESTAMP.
  • Bookshop Schema Design: Section headers for importing Bookshop data have been renamed for better clarity and consistency, distinguishing between TiDB Self-Managed and TiDB Cloud import methods.

🧠 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
  • develop/dev-guide-bookshop-schema-design.md
    • Updated the introductory text for importing Bookshop table structures and data.
    • Renamed 'Method 1: Via tiup demo' to 'TiDB Self-Managed: via tiup demo'.
    • Renamed 'Method 2: Via TiDB Cloud Import' to 'TiDB Cloud: via the Import feature'.
  • develop/dev-guide-connection-parameters.md
    • Added a 'Tip' block to highlight sections excerpted from 'Best Practices for Developing Java Applications with TiDB'.
    • Updated the internal link to the Java best practices document.
  • develop/dev-guide-delete-data.md
    • Reformatted the note regarding DATETIME and TIMESTAMP types into a bulleted list for improved readability.
    • Clarified the year-2038 problem recommendation for the TIMESTAMP data type.
  • develop/dev-guide-get-data-from-single-table.md
    • Corrected a typo from conn.createStatus() to conn.createStatement() in the Java code example description.
    • Updated the referenced JDBC sample application documentation link.
  • develop/dev-guide-insert-data.md
    • Standardized the wording for bulk-import/export tools (e.g., 'use [tool]' instead of 'Data export: [tool]').
    • Replaced external links for Dumpling, TiDB Data Migration, and Backup & Restore with internal documentation links.
    • Updated descriptions for TiDB Cloud import/export features to be more concise and consistent.
  • develop/dev-guide-third-party-tools-compatibility.md
    • Clarified guidance about avoiding MySQL server status variables for monitoring.
    • Updated the formatting and wording for links to TiDB Cloud and Self-Managed monitoring documentation.
  • develop/dev-guide-use-follower-read.md
    • Refined the instructions for using Key Visualizer in both TiDB Cloud and Self-Managed environments, integrating the 'check whether a read hotspot occurs' step directly into the bullet points.
    • Updated the link and wording for hotspot troubleshooting guidance.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded or provided in the pull request description since its creation.
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.

@qiancai qiancai self-assigned this Feb 5, 2026
@qiancai qiancai added the type/refactor The issue belongs to a refactor work. label Feb 5, 2026
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 introduces a series of documentation fixes and clarifications across several developer guides, enhancing accuracy, consistency, and navigation. The changes are generally positive. I've identified a few minor issues, including broken links in develop/dev-guide-connection-parameters.md, a formatting inconsistency in develop/dev-guide-insert-data.md, and a grammatical error in develop/dev-guide-use-follower-read.md. I have provided specific suggestions to address these points.

@qiancai qiancai added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels Feb 5, 2026
qiancai and others added 3 commits February 5, 2026 20:01
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 6, 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 ask for approval from qiancai. 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 the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Feb 6, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 6, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-02-06 09:44:39.43816645 +0000 UTC m=+1123.405343315: ☑️ agreed by lilin90.

@ti-chi-bot
Copy link

ti-chi-bot bot commented Feb 6, 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 81abd79 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.

@qiancai qiancai merged commit d0f279a into pingcap:feature/preview-top-navigation Feb 6, 2026
4 of 8 checks passed
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. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/M Denotes a PR that changes 30-99 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.

2 participants