[MODULES-8183] Core Modules: Table of Contents is Truncated in some REFERENCE.md files Created: 2018/10/26  Updated: 2020/03/17

Status: Accepted
Project: Modules
Component/s: augeas_core, cron_core, host_core, mount_core, selinux_core, sshkeys_core, yumrepo_core, zfs_core, zone_core
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Normal
Reporter: Erwin Hom Assignee: Unassigned
Resolution: Unresolved Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Screen Shot 2019-08-15 at 10.56.08 AM.png    
Template: MODULES Bug Template
Team: Night's Watch
Sprint: PR - Triage
Method Found: Inspection
QA Risk Assessment: Needs Assessment


Core Modules: Table of Contents shows text truncation in some REFERENCE.md files


Is there an issue with Puppet Strings?


Comment by Erwin Hom [ 2018/10/26 ]

According to Eric Putnam:

This is a "feature" for the table of contents, Strings prefers a @summary tag but will use a truncated overview. in retrospect it was a bad idea but it is what it is. i believe it says to keep the summary brief in the docs but if there is no summary, it'll grab the "overview" which is anything outside of a tag.

cc Josh Cooper

Comment by Garrett Guillotte [ 2019/08/15 ]

Results in a repeated "Resource types" h2 and mangled Markdown formatting on the Forge:

Generated at Mon Sep 28 14:43:30 PDT 2020 using Jira 8.5.2#805002-sha1:a66f9354b9e12ac788984e5d84669c903a370049.