tidbcloud / tidbcloud/ti-cli

Docs: quick start install command points at tidbcloud/ti (404) instead of tidbcloud/ti-cli

Open Beginner friendly
#52 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

Problem

The install command in the "Get Started with TiDB Cloud CLI" quick start points at a repo path that returns 404 for anyone outside the org, so a reader following the quick start cannot install the CLI.

In the docs (/ai/ti-quick-start/, Step 1):

curl -fsSL https://github.com/tidbcloud/ti/releases/latest/download/install.sh | sh -s -- -- yes

Verified:

URL Result
https://github.com/tidbcloud/ti/releases/latest/download/install.sh 404
https://api.github.com/repos/tidbcloud/ti 404 — repo not public
https://github.com/tidbcloud/ti-cli/releases/latest/download/install.sh 200
https://api.github.com/repos/tidbcloud/ti-cli 200

The repo is tidbcloud/ti-cli, not tidbcloud/ti.

The Windows PowerShell block in the same step has the same problem (.../tidbcloud/ti/releases/latest/download/install.ps1).

Why it matters now

This page is the primary CTA target of the TiDB Cloud Filesystem landing page, which went live today at https://www.pingcap.com/tidb/tidb-cloud-filesystems/ — so the install command is the first thing a visitor copies after clicking Quickstart.

For what it's worth, the shortlink used on the landing page resolves correctly:
https://tidb.link/ti-cli-installhttps://github.com/tidbcloud/ti-cli/releases/latest/download/install.sh (200). So the landing page is right and the docs are stale.

Suggested fix

Replace tidbcloud/ti with tidbcloud/ti-cli in both the shell and PowerShell install snippets — or point both at https://tidb.link/ti-cli-install, which is already the shortlink and survives future repo renames.

Happy to send the PR if you point me at where the /ai/ti-* sources live — they aren't under ai/ in pingcap/docs on master, so I couldn't locate them.

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

Locate the source for /ai/ti-quick-start/, since the payload says it is not under ai/ in pingcap/docs on master. Update the Step 1 shell and PowerShell snippets to use tidbcloud/ti-cli or the documented shortlink, then verify both install URLs no longer reference tidbcloud/ti.

Written by the indexing model from the issue text.

Assessment

Tech stack
powershell, shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.