docs icon indicating copy to clipboard operation
docs copied to clipboard

Add anchor links on each individual cluster setting and session variable

Open sheaffej opened this issue 4 years ago • 3 comments

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

Compare to the Prometheus docs that have anchor links for each setting: image

Jira Issue: DOC-962

sheaffej avatar Feb 02 '21 02:02 sheaffej

+1, cluster and session settings are frequently mentioned in support issues as a potential workaround/resolution. It would be great if we could link a specific setting.

vy-ton avatar Nov 01 '21 14:11 vy-ton

Duplicated by #9960.

ianjevans avatar Nov 01 '21 15:11 ianjevans

This would involve changes to docgen in the cockroach repo, as we're using a remote include to pull these generated docs.

I would strongly recommend that docgen use some sort of templating system for the output rather than embedding HTML strings within the script.

ianjevans avatar Nov 01 '21 15:11 ianjevans