Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make ToC agree with content headings #300

Open
Tracked by #294 ...
dwelsch-esi opened this issue Nov 11, 2024 · 3 comments · May be fixed by #313
Open
Tracked by #294 ...

Make ToC agree with content headings #300

dwelsch-esi opened this issue Nov 11, 2024 · 3 comments · May be fixed by #313
Assignees

Comments

@dwelsch-esi
Copy link

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.

@andoriyaprashant
Copy link
Contributor

Hello @S-ayanide I would like to work on this issue. Could you please assign it to me

Thank you

@namkyu1999
Copy link
Member

go ahead, @andoriyaprashant !

@andoriyaprashant
Copy link
Contributor

Hello @namkyu1999 please review my pull request #313 Let me know if you would like me to make any changes
Thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants