fleet
fleet copied to clipboard
fleetdm
Docs - Configuration Files page does not have TOC as others do
Fleet version: N/A
Operating system: N/A
Web browser: Chrome
🧑💻 Expected behavior
When I visit the configuration files page of the docs (https://fleetdm.com/docs/using-fleet/configuration-files), I expect to see on the right hand side a table of contents that helps me navigate the document.
💥 Actual behavior
All I see is the top header in the TOC ("Using YAML files in Fleet"), nothing else. When I visit the file, /docs/Using-Fleet/configuration-files/README.md, I see that it does have the TOC specified at the top, like other places where it does work.
Impact
I suspect this is a key page in the documentation, since it features information on configuration. It's a very long page and therefore really hard/annoying to look through without the TOC.
More info
Maybe this is because this page follows an unconventional multi-page structure?
@zhumo Thanks! And, right! It would be Eric, on Mike T's team. I also tagged this with the current iteration, since bug fixes get prioritized first.
@eashaw Likely something breaking the regex in the code that builds the right-side nav from section headings, if I had to guess? This doesn't necessarily need a change to that code though. Depending on the problem, the fix may also just be to edit the markdown.
@zhumo @mikermcneil This is happening because this page only has one h2 heading (## Using YAML files in Fleet).
To fix this we need to change the levels of the headings in the Markdown.
PR has been merged. The Configuration files doc now has a table of contents like other docs.