cockroachdb / cockroachdb/docs

Add anchor links on each individual cluster setting and session variable

Ouverte
#9,686 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
C-doc-improvement P-2
Langage dominant
HTML
Étoiles
212
Forks
476
Merge moyen
40 min
PR mergées (30 j)
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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.