tidbcloud / tidbcloud/ti-cli

Docs: CLI overview introduces "Drive9" as a second product name with no explanation

Open
#53 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
3
Forks
1
Avg merge
22h 20m
Merged PRs (30d)
5

Description

What a reader sees

The public CLI overview at /ai/ti-overview/ carries an H2 section titled "TiDB Cloud CLI and Drive9", and Drive9 appears 5 times on that page:

TiDB Cloud CLI and Drive9
The TiDB Cloud CLI installs a bundled Drive9 companion named ti-drive9. The TiDB Cloud CLI owns profile selection, TiDB Cloud credentials, region and Filesystem selection, output formatting, and ti error behavior. The companion owns Filesystem data-plane semantics, FUSE and WebDAV mounts, layers, pack and unpack, Git workspace acceleration, journals, and vault operations. You do not need to install, configure, or invoke Drive9 separately for normal TiDB Cloud CLI workflows.

Why this is worth a decision rather than a quick edit

ti-drive9 is a real binary that ships and lands on the user's machine, so this isn't simply stale text that can be deleted — a reader who lists their install directory will see the name regardless. But right now it's the only place a public reader meets it, and it arrives with no explanation of what Drive9 is or how it relates to the product they came for.

The naming is inconsistent across our public surfaces:

  • Product marketing uses TiDB Cloud Filesystem exclusively — the landing page that launched today (https://www.pingcap.com/tidb/tidb-cloud-filesystems/) never mentions Drive9.
  • These docs introduce Drive9 as a second named component.
  • The last paragraph then tells the reader they don't need to think about it — which raises the question of why it's given a section heading at all.

So a reader arriving from the landing page meets an unexplained second product name at the exact moment they're deciding whether to trust the CLI.

Options

  1. Keep the binary, drop the branding. Describe it functionally — "the CLI bundles a data-plane companion (ti-drive9) that handles mounts, layers, journals and vault operations" — and remove Drive9 from the heading. Reader gets the fact without a second brand to learn.
  2. Keep it and explain it, if Drive9 is meant to be a public name — one line on what it is and how it relates to TiDB Cloud Filesystem.
  3. Demote it out of an H2 into a note under "What TiDB Cloud CLI manages", since the section's own conclusion is that users don't interact with it.

I'd suggest (1) unless there's a deliberate plan to make Drive9 a public-facing name — in which case it needs a proper introduction, not a passing mention.

Flagging rather than sending a PR because this is a naming call, not a typo. Happy to write whichever version you pick.

/cc whoever owns CLI naming

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the public CLI overview at /ai/ti-overview/ and review the H2 section "TiDB Cloud CLI and Drive9" alongside the TiDB Cloud Filesystem naming described in the issue. First confirm the intended product naming with the CLI owner, then update the section according to the chosen option. Done means the page explains the bundled companion consistently without leaving readers unsure whether Drive9 is a separate product.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
cli, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.