Broken link on cluster topology template
Open
Nobody has claimed this yet.
type/bug
- Dominant language
- Go
- Stars
- 466
- Forks
- 338
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 8
Description
Bug Report
Please answer these questions before submitting your issue. Thanks!
- What did you do?
Open links listed on the topology generated by tiup cluster template
# # Server configs are used to specify the runtime configuration of TiDB components.
# # All configuration items can be found in TiDB docs:
# # - TiDB: https://pingcap.com/docs/stable/reference/configuration/tidb-server/configuration-file/
# # - TiKV: https://pingcap.com/docs/stable/reference/configuration/tikv-server/configuration-file/
# # - PD: https://pingcap.com/docs/stable/reference/configuration/pd-server/configuration-file/
- What did you expect to see?
Open the configuration docs as per component.
I suppose that following are correct ones.
- TiDB: https://docs.pingcap.com/tidb/stable/tidb-configuration-file
- TiKV: https://docs.pingcap.com/tidb/stable/tikv-configuration-file
- PD: https://docs.pingcap.com/tidb/stable/pd-configuration-file
-
What did you see instead?
404 page onhttps://docs.pingcap.com/ -
What version of TiUP are you using (
tiup --version)?
❯ tiup --version
1.11.1 tiup
Go Version: go1.19.2
Git Ref: v1.11.1
GitHash: b95172df211e4f9b643590f2dd8436ad60c72b38
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the tiup cluster template entry point for the three outdated configuration URLs shown in the report. Compare them with the proposed TiDB, TiKV, and PD documentation URLs, then run tiup cluster template and verify that each generated link opens the corresponding configuration page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100