-
Notifications
You must be signed in to change notification settings - Fork 710
[WIP]: new nav: replaced <CustomContent> content with unified instructions for developer guides #22353
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: feature/preview-top-navigation
Are you sure you want to change the base?
Conversation
|
[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 |
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 improves the developer documentation by standardizing how platform-specific information is presented. By eliminating conditional rendering tags and integrating unified instructions, the guides now offer a more cohesive and user-friendly experience, making it easier for developers to find relevant information for both TiDB Cloud and TiDB Self-Managed environments. 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. 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
|
There was a problem hiding this 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 does an excellent job of unifying platform-specific content by removing <CustomContent> blocks across numerous developer guides. The changes significantly improve clarity and maintainability. The updated "Need help?" sections are now consistent and provide clearer support paths for both TiDB Cloud and Self-Managed users. I've identified a few minor issues related to grammar, typos, and consistency, along with one point of potential confusion in an import instruction. Overall, this is a very positive and impactful change.
|
|
||
| </CustomContent> | ||
| - For TiDB Cloud, you can skip [Method 1: Via `tiup demo`](#method-1-via-tiup-demo) and import Bookshop table structures [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import). | ||
| - For TiDB Self-Managed, you can import Bookshop table structures and data either [via TiUP](#method-1-via-tiup-demo) or [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction for TiDB Self-Managed users is a bit confusing. It suggests they can use "the import feature of TiDB Cloud", but Method 2 is specific to TiDB Cloud users and requires a TiDB Cloud account. For clarity, I suggest simplifying this instruction to only mention the TiUP method, which is the primary way for self-managed users to import this data.
| - For TiDB Self-Managed, you can import Bookshop table structures and data either [via TiUP](#method-1-via-tiup-demo) or [via the import feature of TiDB Cloud](#method-2-via-tidb-cloud-import). | |
| - For TiDB Self-Managed, you can import Bookshop table structures and data [via TiUP](#method-1-via-tiup-demo). | |
References
- The documentation should be clear and easy to understand for users. This instruction might confuse users of TiDB Self-Managed. (Reference: Lines 14, 21) (link)
| <CustomContent platform="tidb-cloud"> | ||
|
|
||
| - After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`. | ||
| After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There seems to be a typo in the method name. conn.createStatus() should be conn.createStatement().
| After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatus()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB. | |
| After [connecting to TiDB using the JDBC driver](/develop/dev-guide-choose-driver-or-orm.md#java-drivers), you can create a `Statement` object with `conn.createStatement()`, and then call `stmt.executeQuery("query_sql")` to initiate a database query request to TiDB. | |
References
- The documentation must be technically accurate. The method name
createStatus()is incorrect and should becreateStatement(). (Reference: Line 16) (link)
| > The steps provided in this guide is **_ONLY_** for quick start. For more instructions, refer to [Use an HTAP Cluster with TiFlash](/tiflash/tiflash-overview.md). | ||
| </CustomContent> | ||
| > The steps provided in this section is **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a minor grammatical error here. Since "steps" is plural, the verb should be "are" instead of "is".
| > The steps provided in this section is **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md). | |
| > The steps provided in this section are **_ONLY_** for quick start and testing purposes. For more information about HTAP usage in TiDB, see [explore HTAP](/explore-htap.md). | |
References
- The documentation should have correct English grammar. 'steps' is plural and requires the verb 'are'. (Reference: Line 20) (link)
| - [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md). | ||
| - [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency across the documentation, it's better to remove the periods at the end of these list items, as they are not complete sentences.
| - [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md). | |
| - [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md). | |
| - [SQL Tuning Overview for TiDB Cloud](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) | |
| - [SQL Tuning Overview for TiDB Self-Managed](/sql-tuning-overview.md) | |
| </SimpleTab> | ||
|
|
||
| <CustomContent platform="tidb-cloud"> | ||
| ## Next step |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For better readability and consistency with other documentation, consider changing the heading from "Next step" to "Next steps".
| ## Next step | |
| ## Next steps | |
References
- Headings should use sentence case. 'Next steps' is more conventional and aligned with this principle than 'Next step'. (Reference: Line 32) (link)
What is changed, added or deleted? (Required)
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?