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

未关闭
  • 哪里不对？
#53 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
文档
描述清晰度
需要澄清
活跃度
活跃
技术栈
go
领域
cli, documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Go
星标
3
派生
4
平均合并
3 天 19 小时
30 天内合并 PR
5

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

tidbcloud/ti-cli 的其他 Issue

查看 tidbcloud/ti-cli 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。