*: add custom Japanese localization for cloud docs #21612
Conversation
Introduced <CustomContent language="ja"> blocks throughout TiDB Cloud documentation to provide Japanese-specific content and cloud provider details. This improves localization and clarity for Japanese users, especially regarding supported cloud platforms and feature availability.
|
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
missing-translation-status
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @lilin90, 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 introduces custom Japanese localization for TiDB Cloud documentation. It uses blocks to provide Japanese-specific content, primarily to reflect that Alibaba Cloud is not supported for Japanese users, ensuring clarity and accuracy for the target audience.
Highlights
- Custom Japanese Localization: Implemented custom Japanese localization using tags across various TiDB Cloud documentation files.
- Cloud Provider Differentiation: Tailored content to specify supported cloud providers for Japanese users (AWS, Google Cloud, Azure), explicitly omitting Alibaba Cloud where applicable.
- Documentation Accuracy: Ensured documentation accuracy for Japanese users regarding architecture concepts, connection methods, cluster creation, security, high availability, billing, and FAQs.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces Japanese localization for the TiDB Cloud documentation by using <CustomContent> tags. The changes primarily involve removing references to Alibaba Cloud for the Japanese audience, which is consistent with the PR's goal. The implementation is mostly correct, but I found one instance of nested <CustomContent> tags in tidb-cloud/tidb-cloud-faq.md that could cause rendering issues. I've provided a suggestion to correct this. Overall, the changes are well-executed.
tidb-cloud/tidb-cloud-faq.md
Outdated
| <CustomContent language="en,zh"> | ||
|
|
||
| TiDB Cloud makes deploying, managing, and maintaining your TiDB clusters even simpler with a fully managed cloud instance that you control through an intuitive console. <CustomContent language="en,zh">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, or Alibaba Cloud to quickly build mission-critical applications.</CustomContent><CustomContent language="ja">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, or Microsoft Azure to quickly build mission-critical applications.</CustomContent> |
There was a problem hiding this comment.
There appears to be an issue with nested <CustomContent> tags here. The outer <CustomContent language="en,zh"> tag is unnecessary and will likely cause rendering problems. The content should be structured to only wrap the specific sentence that differs between languages, rather than the entire block.
| <CustomContent language="en,zh"> | |
| TiDB Cloud makes deploying, managing, and maintaining your TiDB clusters even simpler with a fully managed cloud instance that you control through an intuitive console. <CustomContent language="en,zh">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, or Alibaba Cloud to quickly build mission-critical applications.</CustomContent><CustomContent language="ja">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, or Microsoft Azure to quickly build mission-critical applications.</CustomContent> | |
| TiDB Cloud makes deploying, managing, and maintaining your TiDB clusters even simpler with a fully managed cloud instance that you control through an intuitive console. <CustomContent language="en,zh">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, or Alibaba Cloud to quickly build mission-critical applications.</CustomContent><CustomContent language="ja">You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, or Microsoft Azure to quickly build mission-critical applications.</CustomContent> |
Deleted an unnecessary <CustomContent> tag from the TiDB Cloud FAQ to clean up the documentation and improve readability.
ti-chi-bot
bot
removed
the
missing-translation-status
What is changed, added or deleted? (Required)
Introduced
<CustomContent language="ja">blocks throughout TiDB Cloud documentation to provide Japanese-specific content and cloud provider details. This improves localization and clarity for Japanese users, especially regarding supported cloud platforms and feature availability.Related issue: pingcap/website-docs#631
Related FE PR: pingcap/website-docs#630
Note
This PR hasn't remove
- [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)from TOC files yet. Either use CustomContent for TOC files, or directly remove the corresponding line from thei18n-ja-release-8.5branch.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?