Jira (PDOC-268) Colliding internal anchors on autogenerated pages

[Ben Ford (JIRA)]

Ben Ford created an issue

Puppet Strings / PDOC-268 Colliding internal anchors on autogenerated pages Issue Type: Bug Assignee: Unassigned Created: 2018/10/17 3:07 AM Priority: Normal Reporter: Ben Ford When different elements have parameters with the same name, the internal anchors can collide. This means, for example, that the documentation on the Forge provides links that go to the wrong place. Example: Load the puppetlabs/mysql reference page. Scroll down to see the sql task entry in the table of contents and click it. Observe that you're now looking at the sql parameter of the mysql::db defined type. Add Comment

This message was sent by Atlassian JIRA (v7.7.1#77002-sha1:e75ca93)

[Jesse Scott (JIRA)]

Jesse Scott updated an issue

Puppet Strings / PDOC-268 Colliding internal anchors on autogenerated pages

Looks like we need to make the Table of Contents anchors use the same disambiguation algorithm as the Forge does for multiple headings with the same text value. We should also investigate if there is a standard for this so we can safely predict what the anchor values will be ahead of time.

Add Comment

[Daniel Parks (Jira)]

Daniel Parks commented on PDOC-268

Re: Colliding internal anchors on autogenerated pages I fixed this in Puppet Strings: PR #303 (Issue #300). See the PR for a description of the change (pasting it here doesn’t work well), or look at these two changes: param link, fragment normalization Unfortunately, it appears that Forge strips the <a name="..."></a> elements out of the generated documentation, so they are still broken there. For example, https://forge.puppet.com/modules/dp/golang/reference#golang–from_tarball Would you like me to file a new ticket for that? It’s arguably a separate issue.

Add Comment

This message was sent by Atlassian Jira (v8.20.11#820011-sha1:0629dd8)