1485175 - Missing Anchor Tags on /en-US/about/governance/policies/security-group/certs/policy/

Status: VERIFIED FIXED

(www.mozilla.org :: Pages & Content, enhancement)

Description

[Wayne Thayer]

The section headings on the Root Store Policy page (https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/) used to include anchor tags that allowed us to reference specific sections via hyperlinks. This is now missing. Since I didn't change the formatting of the content source, I'm wondering if this is a side-effect of bug 1453754?

The other possibility is that it's a problem in the MD-->HTML processing similar to https://bugzilla.mozilla.org/show_bug.cgi?id=1470221#c10

Is there any way for the system to automatically add anchor tags to the headings as it did in the past?

I'm creating the document in GitHub markdown (https://github.com/mozilla/pkipolicy/blob/master/rootstore/policy.md), so I'm not sure if manually adding anchor tags would translate to the final HTML, but I can also do that if necessary.

Comment 1

[Paul [:pmac] McLanahan]

Hi Wayne. Those have been manually handed in the past because there were links to those anchors in the document. Those links are no longer present in the new version so they were not added to the document. If you have anchors you'd like to have added to the page to certain section headings just let me know and I'm happy to add them. Anchors aren't something that Markdown supports by default, but there are extensions we can use if you'd like for them to be included in your Markdown document.

Comment 2

[Wayne Thayer]

Hi Paul, thanks for the quick response! I don't think I changed anything in the doc related to links, so I'm confused by your comments. I also noticed that the MD version contains the anchors in both the older and current versions. For example: https://github.com/mozilla/pkipolicy/blob/2.6/rootstore/policy.md#2-certificate-authorities

That is a pretty good example of what we want - anchors on all the headings so that we can, at any point in the future, link directly to that section of the doc (mouse over/click on each of the section headings in the link above and you'll see what I mean).

Comment 3

[Paul [:pmac] McLanahan]

I'll see what I can do. I'm sure there's an extension that will add those headers for us. Github does that automatically, but our tools don't at the moment.

What I was referring to was older versions of the document, like:

https://github.com/mozilla/pkipolicy/blob/2.4/rootstore/policy.md

That has links to other sections of the doc near the top of the doc itself, so we needed to make sure to add those anchors so that those links would work. No such section exists in the new version.

I'll get back to you soon on adding section anchors.

Comment 4

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/bedrock/pull/6067

Comment 5

[Wayne Thayer]

Thanks, I think that automatically generating the anchors is the best bet.

If I were to create a table of contents, we'd want it to list all of the subsections. Kathleen had suggested that this would be a good idea if it could be displayed on the right sidebar along with the "About Mozilla" and other nav. Is that even possible?

Comment 6

[Paul [:pmac] McLanahan]

(In reply to Wayne Thayer [:wayne] from comment #5)
> Thanks, I think that automatically generating the anchors is the best bet.
> 
> If I were to create a table of contents, we'd want it to list all of the
> subsections. Kathleen had suggested that this would be a good idea if it
> could be displayed on the right sidebar along with the "About Mozilla" and
> other nav. Is that even possible?

I just filed the above pull-request which uses the "Table of Contents" Markdown extension[0], which does have the ability to automatically output a TOC, and I don't see why we couldn't put it anywhere we want. If you're interested in that feel free to file a bug on it and we'll add it to the queue.

[0] https://python-markdown.github.io/extensions/toc/

Comment 7

[[github robot]]

Commit pushed to master at https://github.com/mozilla/bedrock

https://github.com/mozilla/bedrock/commit/5d972b5e032edfca3cc1321770988658c79738c9
Fix bug 1485175: Add anchors to certs policy page

Also update the process in a comment on the page to include
anchor generation in future updates.

Comment 8

[Paul [:pmac] McLanahan]

This is going to production now. You should see the anchors on the site within the hour.

Comment 9

[Kathleen Wilson]

It works!  Thanks!

Example:
https://www.mozilla.org/en-US/about/governance/policies/security-group/certs/policy/#313-audit-parameters

Comment 10

[Paul [:pmac] McLanahan]

Fantastic! Glad it's all working for you.

And :wayne, please do file that bug for the Table of Contents if you're interested in having that be a part of the page and I'm sure we can make it happen. Be sure to CC me on it if and when you do file it.