release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs#22420
Open
qiancai wants to merge 37 commits intorelease-8.5from
Open
release-8.5: implement a new information architecture for TiDB and TiDB Cloud docs#22420qiancai wants to merge 37 commits intorelease-8.5from
qiancai wants to merge 37 commits intorelease-8.5from
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* *: create TOC and add index for TiDB releases Moved the detailed release notes navigation from TOC.md to a new TOC-tidb-releases.md file. Renamed releases/release-notes.md to releases/_index.md and updated all references to the new path across documentation. This change improves maintainability and centralizes release notes navigation. * Reformat and reorganize TiDB releases TOC Updated TOC-tidb-releases.md to use markdown headings for sections and improved the structure for better readability. No content changes to the release list; only formatting and organization were modified. * Improve formatting of TiDB Cloud releases TOC Reorganized the table of contents in TOC-tidb-cloud-releases.md for better readability by adding section headers and updating list formatting. * Add alias for TiDB v8.5 release notes Added '/tidb/v8.5/release-notes/' to the list of aliases for the release notes page to improve accessibility for users seeking v8.5 documentation.
Standardized section headers and link labels for TiDB Cloud and Self-Managed APIs in the table of contents. Improved clarity by renaming links to include 'API' and removed the beta image from the TiDB Cloud section.
…t-practices.md to /develop (#22360)
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…or developer guides (#22353)
* new nav: categorize best practices TOC items Organized the table of contents into sections: Overview, Schema Design, Deployment, Operations, Performance Tuning, and Application Scenarios. This improves readability and helps users find relevant best practices more easily. * Refactor TOC to use nested list format Reorganized the Table of Contents in TOC-best-practices.md to use a nested list format for improved readability and structure. This change groups related best practices under their respective categories using indentation. * Update format * Remove an extra line * Update TOC-best-practices.md
* *: enrich best practices index and move one doc * Expand TiDB best practices overview and schema design Added detailed sections and tables for best practice topics, including an overview and schema design recommendations. Introduced links to specific best practice documents for DDL management, UUID primary keys, multi-column indexes, and index management. Added placeholders for deployment, operations, and performance tuning sections. * Update best practices index and PD scheduling terms Expanded the best practices index with detailed tables and descriptions for deployment, operations, and performance tuning topics. Updated 'scale-down' terminology to 'scale-in' in the PD scheduling best practices document for consistency and clarity. * Add aliases to public cloud best practices doc Added aliases to the TiDB best practices on public cloud documentation for improved URL compatibility and easier access. * Update descriptions * Update wording * Apply suggestions from code review Co-authored-by: Grace Cai <qqzczy@126.com> * Update _index.md --------- Co-authored-by: Grace Cai <qqzczy@126.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: qiancai <qqzczy@126.com>
Co-authored-by: lilin90 <lilin@pingcap.com>
…or best practices (#22383)
* fix link issues reported by the toc check * fix link issues reported by link and anchor checks * Update tidb-mcp-cursor.md * Apply suggestions from code review Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
* toc: move installation packages * Clarify TOC entry: TiDB Installation Packages Update TOC.md to change the entry text from "Installation Packages" to "TiDB Installation Packages" to make it explicit that the linked binary package information pertains to TiDB.
* Update dev-guide-bookshop-schema-design.md * Update and clarify multiple dev guides * Apply suggestions from code review * Update dev-guide-third-party-tools-compatibility.md * Update develop/dev-guide-use-follower-read.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> * Update TOC-develop.md * Fix two anchor links --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Lilian Lee <lilin@pingcap.com>
ti-chi-bot
bot
added
area/develop
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
size/XXL
qiancai
changed the title
Contributor
Summary of ChangesHello @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 significantly reorganizes the documentation structure by introducing new top-level navigation categories for AI, API, Best Practices, Developer Guides, and TiDB Releases. It aims to provide a clearer and more intuitive user experience by centralizing related content and updating numerous internal links. The changes also involve a substantial cleanup of platform-specific content tags, leading to a more unified documentation base. Highlights
🧠 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
Ignored Files
Using Gemini Code AssistThe 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
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 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request primarily reorganizes and centralizes documentation related to AI features, APIs, best practices, and developer guides. New Table of Contents files (TOC-ai.md, TOC-api.md, TOC-best-practices.md, TOC-develop.md, TOC-tidb-cloud-releases.md, TOC-tidb-releases.md) have been added to provide structured navigation for these topics. Concurrently, existing TOC files (TOC-tidb-cloud-essential.md, TOC-tidb-cloud-premium.md, TOC-tidb-cloud-starter.md, TOC-tidb-cloud.md, TOC.md) have undergone significant removals, with entire 'Develop', 'Vector Search', 'API Reference', 'Best Practices', and 'Releases' sections being excised, indicating a shift towards a more modular documentation structure. Many internal links related to vector search, DDL, and developer guides have been updated to reflect the new centralized AI documentation paths or external URLs. Additionally, several headings in the new TOC-ai.md file were updated to follow sentence case style guidelines, and a broken link to /ai/guides/quickstart-via-sql.md was corrected to /ai/quickstart-via-sql.md. Minor textual corrections and clarifications were also made across various files, including fixing a typo in conn.createStatus() to conn.createStatement() and updating descriptions for full-text search availability and swap_flag recommendations.
| | Document | Description | | ||
| | --- | --- | | ||
| | [Get Started with Python](/ai/quickstart-via-python.md) | Build your first AI application with TiDB in minutes using Python. | | ||
| | [Get Started with SQL](/ai/guides/quickstart-via-sql.md) | Quick start guide for vector search using SQL. | |
Contributor
There was a problem hiding this comment.
This link appears to be broken. The path /ai/guides/quickstart-via-sql.md does not seem to exist in this PR. The correct path should be /ai/quickstart-via-sql.md.
Suggested change
| | [Get Started with SQL](/ai/guides/quickstart-via-sql.md) | Quick start guide for vector search using SQL. | | |
| | [Get Started with SQL](/ai/quickstart-via-sql.md) | Quick start guide for vector search using SQL. | |
|
|
||
| - v8.5 | ||
| - [8.5.4](/releases/release-8.5.4.md) | ||
| - [8.5.3](/releases/release-8.5.3.md) |
Contributor
There was a problem hiding this comment.
According to the style guide (line 32), headings should use sentence case. Please update this heading to Maintenance notifications.
Suggested change
| - [8.5.3](/releases/release-8.5.3.md) | |
| ## Maintenance notifications |
References
- Headings should be in sentence case, for example,
## Configure the cluster. (link)
| For more information on how to handle hotspot issues, refer to [Troubleshoot Hotspot Issues](/troubleshoot-hot-spot-issues.md). | ||
|
|
||
| </CustomContent> | ||
| For more information on how to handle hotspot issues in TiDB Self-Managed, see [Troubleshoot Hotspot Issues](/troubleshoot-hot-spot-issues.md). |
Contributor
There was a problem hiding this comment.
This change removes the platform-specific <CustomContent> blocks and provides a single, clear instruction. This improves readability and maintainability.
Comment on lines
+117
to
+119
| After [connecting to TiDB using the JDBC driver](/develop/dev-guide-sample-application-java-jdbc.md), you can create a `Statement` object with `conn.createStatement()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB. | ||
|
|
||
| - Then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB. | ||
| - The query results are stored in a `ResultSet` object. By traversing `ResultSet`, the returned results can be mapped to the `Author` object. | ||
| The query results are stored in a `ResultSet` object. By traversing `ResultSet`, the returned results can be mapped to the `Author` object. |
Contributor
There was a problem hiding this comment.
The original text contained a typo conn.createStatus(). This has been corrected to conn.createStatement(). Additionally, the explanation has been streamlined for better clarity by removing the <CustomContent> blocks.
|
@qiancai: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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
added
translation/doing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What is changed, added or deleted? (Required)
This PR reorganizes the documentation structure and improves experiences of developers by making the following changes:
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?