Make headings anchors in the docs

[Lee Trager]

Our docs have a number of pages with lots of information separated by headers. When linking a user to documentation it would be nice to be able to link to a specific section.

For example our power-management page[1] details the arguments that every power type has. If I wanted to give a user documentation for IPMI I have to give them the link[1] and tell them to search for IPMI. If each header was an anchor I could click on the header which will give me a link which will jump to that section.

A live example of this can be seen in the Rust documentation[3]

[1] https://maas.io/docs/snap/2.8/ui/power-management
[2] https://maas.io/docs/snap/2.8/ui/power-management#IPMI
[3] https://doc.rust-lang.org/book/ch15-03-drop.html#dropping-a-value-early-with-stdmemdrop

[Adam Collard (adam-collard)]

FWIW, you can get the right link from inspecting the source - https://maas.io/docs/snap/2.8/ui/power-management#heading--ipmi as a case in point :)

[Lee Trager (ltrager)]

ah I didn't realize that, thanks for letting me know. Making the headers a link or showing an anchor icon next to the header would make that more obvious :)

[Bill Wear (billwear)]

I'll see what i can do. each of the power types has a link from a table in
the middle of the page. there are some limitations of using discourse, but
i think i can figure it out and work around them.

On Thu, Oct 15, 2020, 12:45 PM Lee Trager <email address hidden>
wrote:

> ah I didn't realize that, thanks for letting me know. Making the headers
> a link or showing an anchor icon next to the header would make that more
> obvious :)
>
> --
> You received this bug notification because you are a bug assignee.
> https://bugs.launchpad.net/bugs/1900010
>
> Title:
> Make headings anchors in the docs
>
> Status in MAAS:
> New
>
> Bug description:
> Our docs have a number of pages with lots of information separated by
> headers. When linking a user to documentation it would be nice to be
> able to link to a specific section.
>
> For example our power-management page[1] details the arguments that
> every power type has. If I wanted to give a user documentation for
> IPMI I have to give them the link[1] and tell them to search for IPMI.
> If each header was an anchor I could click on the header which will
> give me a link which will jump to that section.
>
> A live example of this can be seen in the Rust documentation[3]
>
> [1] https://maas.io/docs/snap/2.8/ui/power-management
> [2] https://maas.io/docs/snap/2.8/ui/power-management#IPMI
> [3]
> https://doc.rust-lang.org/book/ch15-03-drop.html#dropping-a-value-early-with-stdmemdrop
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/maas/+bug/1900010/+subscriptions
>

[Lee Trager (ltrager)]

I would talk to the design team to see if they can add something so its automatic. I realized github also does this by automatically adding a link icon whenever you mouse over a header

https://github.com/EHfive/pulseaudio-modules-bt/wiki/Packages#ubuntu