netplan

please add anchor tags for all settings

Bug #2024271 reported by Seth Arnold
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
netplan
Triaged
Wishlist
Unassigned

Bug Description

Hello, please add html anchor tags with friendly hyperlink grab-spots to the documentation pages.

I'm trying to suggest a few settings from https://netplan.readthedocs.io/en/stable/netplan-yaml/ that I think will help someone, and the best I can do is suggest strings to search for, rather than giving them a reference to the exact thing I'm thinking of.

Thanks

Revision history for this message
Lukas Märdian (slyon) wrote (last edit ):

ReadThe docs kind of does that for us already, e.g.: https://netplan.readthedocs.io/en/stable/netplan-yaml/#properties-for-physical-device-types

But I assume you'd like to see the same to be available on a more fine-granular level, i.e. per individual setting (e.g. match.macaddress)?

I guess the fix would be to bump individual settings in our docs to a "heading" level, instead of being bullet points, and reformat all of your manpages accordingly.

Changed in netplan:
status: New → Triaged
importance: Undecided → Wishlist
Revision history for this message
Seth Arnold (seth-arnold) wrote :

Exactly, within this one heading there's twenty nine different settings
(based on a very quick by-eye count) -- I'd like to be able to link to any
of those, or any of the other settings elsewhere in the docs.

Thanks

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.