Skip to content

docs: fix TiDB Cloud file system casing to match the product name - #23901

Merged
ti-chi-bot[bot] merged 3 commits into
release-8.5from
fix/tidb-cloud-filesystem-casing
Sep 30, 2026
Merged

ti-chi-bot[bot] merged 3 commits into
release-8.5from
fix/tidb-cloud-filesystem-casing

Conversation

@yahonda

@yahonda yahonda commented Sep 17, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Fixes an inconsistent casing of the "TiDB Cloud Filesystem" product name. 11 places across 7 ai/ti/reference/ pages' Options sections used the lowercase generic wording "TiDB Cloud file system" instead of the product's branded name "TiDB Cloud Filesystem", which is used consistently 243 times elsewhere in the same directory (including these same files' own titles and other option descriptions).

Found while reviewing a Japanese i18n sync PR for this content.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)

This ai/ti/ (TiDB Cloud CLI) content currently exists only on the v8.5 branch, not on master.

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated TiDB Cloud Filesystem terminology across filesystem command references, including commands for copying, linking, layering, deleting, describing, mounting, and packaging files.
    • Standardized capitalization in option descriptions to match the product name.
    • Command behavior, option defaults, and functionality remain unchanged.

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

coderabbitai Bot commented Sep 17, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 66d890ba-3393-4531-9643-d7d3981a0660

📥 Commits

Reviewing files that changed from the base of the PR and between 420868d and 5d82b0a.

📒 Files selected for processing (4)
  • ai/ti/reference/ti-fs-copy-file.md
  • ai/ti/reference/ti-fs-create-hardlink.md
  • ai/ti/reference/ti-fs-delete-file.md
  • ai/ti/reference/ti-fs-describe-file.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The pull request updates seven TiDB CLI reference documents to use “TiDB Cloud Filesystem” consistently. It changes option descriptions only. Command behavior and defaults remain unchanged.

Changes

Filesystem terminology

Layer / File(s) Summary
Reference wording normalization
ai/ti/reference/ti-fs-*.md
Option descriptions use “TiDB Cloud Filesystem” instead of “TiDB Cloud file system.” No functional or default-value changes are made.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: icemap

Merge Risk: ⚪ Minimal · up to 5d82b

The changes standardize the product name in reference descriptions without changing command behavior or defaults. No merge-blocking issue is evident.

Architecture Summary

Architecture risk: 🔵 Low · up to 5d82b

The change affects 1 system.

Changed systems: ai

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — ai (service) was modified; 7 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in ai/ti/reference/ti-fs-create-layer.md: Updated the --base-root-path option description to use the product name "Filesystem" instead of "file system."
  • observed — Modified behavior in ai/ti/reference/ti-fs-mount-file-system.md: The --remote-path option documentation renames "The TiDB Cloud file system root path" to "The TiDB Cloud Filesystem root path"; no functional change to the option or its default /.
  • observed — Modified behavior in ai/ti/reference/ti-fs-pack-file-system.md: Updated the --remote-root option description in the Options section, changing "file system root" to "Filesystem root" to match the product name capitalization used throughout the reference.
  • observed — Modified behavior in ai/ti/reference/ti-fs-copy-file.md: Updated the descriptions for --append, --create-parents, and --from-remote to use “TiDB Cloud Filesystem” instead of “TiDB Cloud file system.”
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: correcting the casing of the TiDB Cloud Filesystem product name.
Description check ✅ Passed The description explains the changes, affected version, scope, AI involvement, and applicable change categories. It is sufficiently complete for review.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

@yahonda
yahonda force-pushed the fix/tidb-cloud-filesystem-casing branch from f6f7852 to 420868d Compare September 18, 2026 08:35
@yahonda
yahonda force-pushed the fix/tidb-cloud-filesystem-casing branch from 420868d to 5d82b0a Compare September 28, 2026 01:56
"TiDB Cloud Filesystem" is the product's branded name and is used
consistently 243 times across ai/ti/. These 7 reference pages'
Options sections used the lowercase generic "TiDB Cloud file system"
in 11 places instead, an inconsistent casing of the same product
name.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the fix/tidb-cloud-filesystem-casing branch from 5d82b0a to 2a3e4c3 Compare September 30, 2026 00:10
@qiancai qiancai self-assigned this Sep 30, 2026
@qiancai qiancai added needs-cherry-pick-master Should cherry pick this PR to master branch. translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Sep 30, 2026
Comment thread ai/ti/reference/ti-fs-copy-file.md Outdated
Comment thread ai/ti/reference/ti-fs-pack-file-system.md Outdated
Comment thread ai/ti/reference/ti-fs-mount-file-system.md Outdated
Comment thread ai/ti/reference/ti-fs-describe-file.md Outdated
Comment thread ai/ti/reference/ti-fs-delete-file.md Outdated
Comment thread ai/ti/reference/ti-fs-create-layer.md Outdated
Comment thread ai/ti/reference/ti-fs-create-hardlink.md Outdated
Comment thread ai/ti/reference/ti-fs-copy-file.md Outdated
Comment thread ai/ti/reference/ti-fs-copy-file.md Outdated
Comment thread ai/ti/reference/ti-fs-copy-file.md Outdated
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 30, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 30, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-30 02:58:15.936827051 +0000 UTC m=+764821.162048158: ☑️ agreed by qiancai.

@qiancai

qiancai commented Sep 30, 2026

Copy link
Copy Markdown
Collaborator

/approve

@qiancai qiancai added the lgtm label Sep 30, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 30, 2026

Copy link
Copy Markdown

[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

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

@qiancai qiancai removed the needs-cherry-pick-master Should cherry pick this PR to master branch. label Sep 30, 2026
@ti-chi-bot ti-chi-bot Bot added the approved label Sep 30, 2026
@ti-chi-bot
ti-chi-bot Bot merged commit af9baf8 into release-8.5 Sep 30, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved lgtm needs-1-more-lgtm Indicates a PR needs 1 more LGTM. size/S Denotes a PR that changes 10-29 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.

2 participants