Skip to content

cloud release-8.1: remove serverless specific docs #21337

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

Draft
wants to merge 3 commits into
base: release-8.1
Choose a base branch
from

Conversation

qiancai
Copy link
Collaborator

@qiancai qiancai commented Jul 7, 2025

What is changed, added or deleted? (Required)

This PR removes TiDB Cloud Serverless specific docs from TiDB Cloud Documentation at https://docs.pingcap.com/tidbcloud/.

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.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 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

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. area/develop This PR relates to the area of TiDB App development. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 7, 2025
@qiancai qiancai changed the base branch from master to release-8.1 July 7, 2025 08:37
@qiancai qiancai added the cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. label Jul 7, 2025
@ti-chi-bot ti-chi-bot bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 7, 2025
@qiancai qiancai added translation/no-need No need to translate this PR. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jul 7, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Jul 7, 2025
Copy link

@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.

Summary of Changes

Hello @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 primarily focuses on streamlining and updating the documentation for the release-8.1 branch. It involves removing outdated or serverless-specific content, reorganizing existing sections for better clarity, and adding new documentation for features and tools relevant to TiDB's self-managed and dedicated cloud offerings. The changes aim to provide a more accurate, comprehensive, and user-friendly documentation experience for the current release.

Highlights

  • Documentation Scope Adjustment: The pull request significantly refines the documentation scope for the release-8.1 branch by removing content specifically tied to TiDB Cloud Serverless, as indicated by the PR title and changes in TOC-tidb-cloud.md and _docHome.md.
  • Content Reorganization and Expansion: Key documentation files like TOC-tidb-cloud.md and TOC.md have undergone extensive restructuring. This includes the introduction of new sections for 'Key Concepts', 'Vector Search', and 'Disaster Recovery', alongside detailed API and CLI references, indicating a shift towards a more structured and comprehensive guide for dedicated/self-managed offerings.
  • Version Alignment and Maintenance: The README.md and TOC.md files are updated to reflect release-8.1 as a Long-Term Support (LTS) version, and new release notes for various versions (v8.5, v8.1, v7.5, v7.1, v6.5) have been added, ensuring the documentation remains current and accurate.
  • Terminology Standardization: Across numerous documentation files, terminology has been standardized, with 'TiDB Serverless' updated to 'TiDB Cloud Serverless', 'TiDB Dedicated' to 'TiDB Cloud Dedicated', and 'TiDB Self-Hosted' to 'TiDB Self-Managed', improving consistency and clarity.
  • New Language Support and Utilities: A new C# sample application guide (develop/dev-guide-sample-application-cs.md) has been added, and new utility functions (functions-and-operators/utility-functions.md) and TiDB-specific functions (functions-and-operators/tidb-functions.md) are now documented, expanding the range of supported development practices.
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

  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

@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 removes entries for TiDB Cloud Serverless from the main Table of Contents (TOC-tidb-cloud.md), which aligns with the stated goal of removing serverless-specific documentation.

@qiancai qiancai marked this pull request as draft July 7, 2025 10:28
@ti-chi-bot ti-chi-bot bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 7, 2025
Copy link

ti-chi-bot bot commented Jul 8, 2025

[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 oreoxmt 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.

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

@ti-chi-bot ti-chi-bot bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 8, 2025
@qiancai qiancai changed the title release-8.1: remove serverless specific docs cloud release-8.1: remove serverless specific docs Jul 8, 2025
@qiancai qiancai added the needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. label Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/develop This PR relates to the area of TiDB App development. cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. needs-cherry-pick-release-8.5 Should cherry pick this PR to release-8.5 branch. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/no-need No need to translate this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant