[MXS-1640] Add anchor links for configuration options in documentation Created: 2018-01-30  Updated: 2018-03-31  Resolved: 2018-03-31

Status: Closed
Project: MariaDB MaxScale
Component/s: Documentation
Affects Version/s: N/A
Fix Version/s: N/A

Type: Task Priority: Major
Reporter: Geoff Montee (Inactive) Assignee: Unassigned
Resolution: Fixed Votes: 0
Labels: documentation


 Description   

If I want to send someone a link to the documentation of a MariaDB server variable, it is really easy to do so because the server documentation has anchor links for each variable. e.g. the documentation for datadir can be found here:

https://mariadb.com/kb/en/library/server-system-variables/#datadir

The MaxScale documentation does not have anchor links for each configuration option. If I want to send someone a link to the documentation for the version_string option, then the best I can do is to send them a link to all options available for Services. e.g.:

https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-mariadb-maxscale-configuration-usage-scenarios/#service

Would it be possible to add anchor links for configuration options to the documentation?



 Comments   
Comment by markus makela [ 2018-01-31 ]

A workaround to this is to manually look for the id tag of the heading and append the value of it to the URL separating it with a number sing e.g. https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-mariadb-maxscale-configuration-usage-scenarios#localhost_match_wildcard_host

Generated at Thu Feb 08 04:08:18 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.