cockroachdb / cockroachdb/docs

Add anchor links on each individual cluster setting and session variable

Open
#9,686 3 comments 1 reaction 0 assignees View on GitHub
C-doc-improvement P-2
Dominant language
HTML
Stars
212
Forks
476
Avg merge
40m
Merged PRs (30d)
3

Description

John Sheaffer (sheaffej) commented:

Please consider adding an anchor link to each individual cluster setting and session variable on the following pages:
https://www.cockroachlabs.com/docs/v20.2/cluster-settings.html
https://www.cockroachlabs.com/docs/v20.2/set-vars.html

When referring customers or co-workers to specific cluster settings or session variables, it would be very helpful to send a link to a specific setting or variable, vs a link to the page listed above and having the recipient search the page to find the setting or variable.

For example in the current docs with no anchor links:
![image](https://user-images.githubusercontent.com/5922798/106544283-1f7f5580-64bc-11eb-889d-e9c6074a337d.png)

Compare to the Prometheus docs that have anchor links for each setting:
![image](https://user-images.githubusercontent.com/5922798/106544903-2f4b6980-64bd-11eb-9085-9ba1b52669f1.png)

Jira Issue: DOC-962

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.