release-8.5: sync the cloud docs to the latest version (#21355) #21360
Conversation
Signed-off-by: ti-chi-bot <ti-community-prow-bot@tidb.io>
|
@qiancai This PR has conflicts, I have hold it. |
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 performs a comprehensive synchronization of the TiDB Cloud documentation from the release-8.1 branch to the release-8.5 branch. The changes introduce significant restructuring, new conceptual overviews, expanded cloud provider support, and enhanced feature guides across various aspects of TiDB Cloud, aiming to provide users with the latest and most organized information.
Highlights
- Documentation Restructuring & Expansion: The TiDB Cloud documentation has undergone a significant overhaul, introducing new top-level sections in the Table of Contents for better organization and adding numerous new conceptual documents covering Architecture, AI Features, Data Service, Scalability, Monitoring, Backup & Restore, Security, SQL, and Database Schema.
- Enhanced Cloud Provider Support: Documentation now includes expanded support for Azure, detailing Private Link connections and Azure Blob Storage for import/export operations, alongside existing AWS and Google Cloud integrations.
- Advanced Data Management Features: New capabilities for Serverless clusters include Parquet format support for data export/import, Alibaba Cloud OSS integration, and detailed updates to backup/restore processes for both Serverless and Dedicated tiers. Serverless audit logging and firewall rules for public endpoints are also newly documented.
- Terraform Provider Updates: The Terraform provider documentation has been updated to introduce new dedicated and serverless cluster resources, deprecating the older generic
tidbcloud_clusterresource, and adding resources for network containers, private endpoint connections, and VPC peering. - Improved User Experience & CLI: UI terminology has been refined (e.g., 'Chat2Query' is now 'SQL Editor'), and the TiDB Cloud CLI has received substantial updates with new commands for SQL user management, audit logging, and enhanced export/import functionalities.
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 is currently in preview and 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 to provide feedback.
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 synchronizes the cloud documentation to the latest version, introducing a significant number of new documents and updates. My review focused on ensuring correctness and clarity, per our style guide. I've identified a few critical issues, such as merge conflicts that need to be resolved, along with some minor grammatical and formatting suggestions to improve readability. Overall, a great set of updates!
TOC-tidb-cloud.md
Outdated
| <<<<<<< HEAD | ||
| - Get Started | ||
| - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) | ||
| ======= | ||
| - Get Started with TiDB Cloud | ||
| - [Try Out TiDB Cloud Serverless](/tidb-cloud/tidb-cloud-quickstart.md) | ||
| >>>>>>> aed3b8f199 (release-8.5: sync the cloud docs to the latest version (#21355)) |
There was a problem hiding this comment.
This file contains merge conflict markers that need to be resolved. Based on the context, the second version seems more descriptive and up-to-date.
| <<<<<<< HEAD | |
| - Get Started | |
| - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) | |
| ======= | |
| - Get Started with TiDB Cloud | |
| - [Try Out TiDB Cloud Serverless](/tidb-cloud/tidb-cloud-quickstart.md) | |
| >>>>>>> aed3b8f199 (release-8.5: sync the cloud docs to the latest version (#21355)) | |
| - Get Started with TiDB Cloud | |
| - [Try Out TiDB Cloud Serverless](/tidb-cloud/tidb-cloud-quickstart.md) |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #21355
What is changed, added or deleted? (Required)
As in the title, this PR replaces the cloud doc files in the release-8.5 branch with the latest files in the release-8.1 branch.
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?