Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Anchors for config options of same name #39

Open
ru-fu opened this issue Apr 10, 2024 · 0 comments
Open

Anchors for config options of same name #39

ru-fu opened this issue Apr 10, 2024 · 0 comments

Comments

@ru-fu
Copy link
Contributor

ru-fu commented Apr 10, 2024

If we have several config options with the same name (for example, one option per storage driver), we cannot link to them in the general documentation (because we don't know which storage driver the user has).
It would be nice if we could link to the config option index instead, where the user can then pick the option that is relevant to them.

That requires adding anchors to the config option index page before every block of options with the same name.

ru-fu added a commit to ru-fu/lxd that referenced this issue Apr 10, 2024
This should cover most config options.

The ones that are still missing are options that exist in different
contexts (for example, for each storage driver). We can't have a
link to those unfortunately.

I've opened canonical/canonical-sphinx-extensions#39
to look into a way of providing a target for such options.

Signed-off-by: Ruth Fuchss <[email protected]>
tomponline pushed a commit to tomponline/lxd that referenced this issue Apr 16, 2024
This should cover most config options.

The ones that are still missing are options that exist in different
contexts (for example, for each storage driver). We can't have a
link to those unfortunately.

I've opened canonical/canonical-sphinx-extensions#39
to look into a way of providing a target for such options.

Signed-off-by: Ruth Fuchss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant