FEATURE REQUEST: Make ToC agree with content headings
Issue: Make ToC agree with content headings
The "Overview" pages in the "Concepts" guide and the User guide both contain synopses of the content within their guides. The table of contents (TOC) on the left displays links to those same sections. To facilitate navigation the information in the overviews should exactly parallel the TOC.
Reorder the "Concepts" table of contents (TOC) so that the items appear in the same order as they do on the Overview page. In cases where an item is missing from one or the other, add it so they agree. In cases where the title of the item is not the same (for example, "Event Triggered Chaos using GitOps" and "Configuring GitOps"), change one so they agree.
Similarly, make the User Guides TOC agree with the User Guides Overview.
Context
This issue tracks recommended changes resulting from an analysis of the Litmus Chaos
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0013-litmuschaos.
Possible Implementation
Move, rename, and add sections in the User Guide Overview so that it has the same sections as shown for the User Guides in the TOC:
Advanced Installation
Environments
Chaos Infrastructure
Injecting Fault
Resilience Probjes
Account Settings
User Management
Managing Projects
Teaming
Configuring GitOps
Using different image registries
Uninstall Litmus
Move, rename, and add sections in the Concepts Overview so that it has the same sections as shown for Concepts in the TOC:
Chaos Infrastructure
ChaosHub
Chaos experiment
Resilience Probes
User management
Projects
Teaming
GitOps
Authentication in ChaosCenter
Also, make sure the TOC entries have consistent capitalization and agree with the Overview headings. For example, "Chaos experiment" is sentence-style capitalization; "Chaos Experiment" is title capitalization. Pick one or the other for the site. Don't mix and match.
FEATURE REQUEST: Make ToC agree with content headings
Issue: Make ToC agree with content headings
The "Overview" pages in the "Concepts" guide and the User guide both contain synopses of the content within their guides. The table of contents (TOC) on the left displays links to those same sections. To facilitate navigation the information in the overviews should exactly parallel the TOC.
Reorder the "Concepts" table of contents (TOC) so that the items appear in the same order as they do on the Overview page. In cases where an item is missing from one or the other, add it so they agree. In cases where the title of the item is not the same (for example, "Event Triggered Chaos using GitOps" and "Configuring GitOps"), change one so they agree.
Similarly, make the User Guides TOC agree with the User Guides Overview.
Context
This issue tracks recommended changes resulting from an analysis of the Litmus Chaos documentation commissioned by CNCF. The analysis and supporting documents are here: https://github.com/cncf/techdocs/tree/main/analyses under
0013-litmuschaos
.Possible Implementation
Move, rename, and add sections in the User Guide Overview so that it has the same sections as shown for the User Guides in the TOC:
Move, rename, and add sections in the Concepts Overview so that it has the same sections as shown for Concepts in the TOC:
Also, make sure the TOC entries have consistent capitalization and agree with the Overview headings. For example, "Chaos experiment" is sentence-style capitalization; "Chaos Experiment" is title capitalization. Pick one or the other for the site. Don't mix and match.