cockroachdb / cockroachdb/docs

Add anchor links on each individual cluster setting and session variable

未关闭
#9,686 3 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
C-doc-improvement P-2
主要语言
HTML
星标
212
派生
476
平均合并
40 分钟
30 天内合并 PR
3

描述

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

贡献指南

这个仓库没有索引到贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。