Skip to content

docs: add TiDB Cloud CLI (tdc) Preview documentation#23306

Open
Icemap wants to merge 2 commits into
pingcap:release-8.5from
Icemap:docs/tdc-preview
Open

docs: add TiDB Cloud CLI (tdc) Preview documentation#23306
Icemap wants to merge 2 commits into
pingcap:release-8.5from
Icemap:docs/tdc-preview

Conversation

@Icemap

@Icemap Icemap commented Jul 17, 2026

Copy link
Copy Markdown
Member

What changed

  • Add complete Preview documentation for TiDB Cloud CLI (tdc), including quick start, concepts, command guides, examples, and references.
  • Cover TiDB Cloud Starter, TiDB Cloud Filesystem, FS Git, Journal, Vault, configuration, security, regions, installation, and updates.
  • Add problem-driven agent scenarios and explain background Git workspace hydration.
  • Register every page in the AI documentation navigation.

Why

tdc needs task-oriented product documentation that gets new users to a working database or Filesystem quickly while still documenting the complete command surface and the tdc/Drive9 boundary.

User impact

Users and coding agents can follow supported release-install workflows, understand credential and platform boundaries, and apply tdc to concrete database, shared-workspace, Git, journal, and secret-delegation scenarios.

Validation

  • PingCAP markdownlint
  • Remark lint and PingCAP anchor validation
  • Internal and external link checks
  • Current tdc command and flag coverage checks
  • English/Chinese command-block parity checks

@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@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 17, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

[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 hfxsd 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

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d55783f2-ad8b-49c7-9627-07d6cc1668da

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Icemap
Icemap marked this pull request as ready for review July 17, 2026 18:56
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jul 17, 2026
@Icemap Icemap added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed missing-translation-status This PR does not have translation status info. labels Jul 17, 2026
@Icemap

Icemap commented Jul 17, 2026

Copy link
Copy Markdown
Member Author

Chinese Translation PR(from this PR): pingcap/docs-cn#21821

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

Labels

size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant