-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Fix version number in links to docs site #18984
Copy link
Copy link
Closed
Labels
C-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.S-3-ux-surpriseIssue leaves users wondering whether CRDB is behaving properly. Likely to hurt reputation/adoption.Issue leaves users wondering whether CRDB is behaving properly. Likely to hurt reputation/adoption.
Description
Links to the docs site generated from the CLI can contain links to "relative versions," e.g., stable. This could lead to problems because an old binary will always link to the newest version's content and if the process changes, the instructions we link to will not provide the correct responses to the user.
Steps to Repro
./cockroach start --insecure
Generates the following response:
*
* WARNING: RUNNING IN INSECURE MODE!
*
* - Your cluster is open for any client that can access <all your IP addresses>.
* - Any user, even root, can log in without providing a password.
* - Any user, connecting as root, can read or write any data in your cluster.
* - There is no network encryption nor authentication, and thus no confidentiality.
*
* Check out how to secure your cluster: https://www.cockroachlabs.com/docs/stable/secure-a-cluster.html
*
Expected Behavior
Link to docs should be:
https://www.cockroachlabs.com/docs/$(binary major version)/secure-a-cluster.html
e.g.
https://www.cockroachlabs.com/docs/v1.0/secure-a-cluster.html
Actual Behavior
Link uses /stable, which is only as valid as long as this version has stable pointed to it.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
C-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.Code not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.S-3-ux-surpriseIssue leaves users wondering whether CRDB is behaving properly. Likely to hurt reputation/adoption.Issue leaves users wondering whether CRDB is behaving properly. Likely to hurt reputation/adoption.