Skip to content

docs: make TiDB Cloud intro machine translation friendly (#22518)#22522

Open
ti-chi-bot wants to merge 3 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-22518-to-release-8.5
Open

docs: make TiDB Cloud intro machine translation friendly (#22518)#22522
ti-chi-bot wants to merge 3 commits intopingcap:release-8.5from
ti-chi-bot:cherry-pick-22518-to-release-8.5

Conversation

@ti-chi-bot
Copy link
Member

This is an automated cherry-pick of #22518

What is changed, added or deleted? (Required)

Since the Japanese version of the documentation is generated via machine translation, I have simplified the source English sentence to improve the translation accuracy and readability:

  • Improved Machine Translation Accuracy: The original sentence contained a complex modification structure ("...that brings ... to your cloud"), which often leads to awkward or incorrect Japanese translations.
  • Simplified Sentence Structure: By using the standard expression "based on [TiDB], an open-source...", the sentence structure is now more straightforward for translation engines to parse correctly.
  • Enhanced Readability: This change ensures a more natural and professional flow in both English and the resulting Japanese translation.

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

yahonda and others added 3 commits March 4, 2026 01:11
Address vale warning reported by reviewdog [PingCAP.LyHyphens] ' fully-' doesn't need a hyphen.
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot added lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR. labels Mar 4, 2026
@ti-chi-bot
Copy link

ti-chi-bot bot commented Mar 4, 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 csuzhangxc 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

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 refactors a key introductory sentence in the TiDB Cloud documentation. The change aims to significantly improve the quality and accuracy of machine translations, particularly for the Japanese version, by simplifying the sentence structure and enhancing overall readability.

Highlights

  • Documentation Improvement: Simplified a complex sentence in the TiDB Cloud introduction to enhance machine translation accuracy and overall readability, especially for the Japanese version.
  • Machine Translation Optimization: Refactored the sentence structure to be more straightforward, using a standard expression to improve how translation engines parse the text.
  • Enhanced Readability: Ensured a more natural and professional flow in both the English source and the resulting translated documentation.

🧠 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
  • tidb-cloud/tidb-cloud-intro.md
    • Simplified the introductory sentence describing TiDB Cloud to improve machine translation accuracy and readability.
Activity
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
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 simplifies the introduction of TiDB Cloud to improve machine translation friendliness, which is a good improvement. I've suggested a minor wording change to make the sentence more active and improve flow. Additionally, the change from fully-managed to fully managed is a good grammatical correction. I noticed other documentation files still use the hyphenated form; it would be beneficial to update them for consistency in a follow-up PR.

Note: Security Review has been skipped due to the limited scope of the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. type/cherry-pick-for-release-8.5 This PR is cherry-picked to release-8.5 from a source PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants