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.

Sign up for GitHub

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

Jump to bottom

Update TOC and Overview for Consistency #313

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update TOC and Overview for Consistency #313

wants to merge 3 commits into from

Conversation

andoriyaprashant
Copy link
Contributor

What this PR does / why we need it:

This pull request addresses the issue of inconsistent section titles and order between the Table of Contents (TOC) and the Overview pages in both the "Concepts" and "User Guides" sections.

Concepts

  • User Guides Overview: Reordered sections to match the User Guide TOC order.
  • Concepts Overview: Reordered sections to match the Concepts TOC order.

Additional Updates:

  • Added concepts/visualize-experiment file in sidebars.js

Which issue this PR fixes #300

Checklist:

@vercel Vercel
Copy link

vercel bot commented Dec 10, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
litmus-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 18, 2024 10:39am

@netlify Netlify
Copy link

netlify bot commented Dec 10, 2024 •
edited
Loading

✅ Deploy Preview for docs-litmuschaos canceled.

Name Link
🔨 Latest commit d3ea1e8
🔍 Latest deploy log https://app.netlify.com/sites/docs-litmuschaos/deploys/6762a5538c8be10008db366b

@andoriyaprashant andoriyaprashant mentioned this pull request Dec 10, 2024
Open
namkyu1999
namkyu1999 requested changes Dec 17, 2024
View reviewed changes
Copy link
Member

@namkyu1999 namkyu1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And could you also make consistent capitalization? For example, "Chaos experiment" is sentence-style capitalization; "Chaos Experiment" is title capitalization.

ex.
Chaos experiment -> Chaos Experiment

website/docs/concepts/overview.md Outdated Show resolved Hide resolved
website/docs/user-guides/overview.md Outdated Show resolved Hide resolved
website/versioned_docs/version-3.12.0/concepts/overview.md Outdated Show resolved Hide resolved
website/versioned_docs/version-3.12.0/user-guides/overview.md Outdated Show resolved Hide resolved
@namkyu1999 namkyu1999 requested review from S-ayanide and removed request for ksatchit, divya-mohan0209 and k8s-dev December 17, 2024 10:17
@andoriyaprashant
Copy link
Contributor Author

Done @namkyu1999

namkyu1999
namkyu1999 requested changes Dec 18, 2024
View reviewed changes
Copy link
Member

@namkyu1999 namkyu1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you apply title capitalization to the text here?

Screenshot 2024-12-18 at 1 52 52 PM

Chaos infrastructure -> Chaos Infrastructure
ChaosHub
Chaos experiment -> Chaos Experiment
Resilience Probes
User management -> User Management
Projects
Teaming
GitOps
Authentication in ChaosCenter
Visualize chaos experiment -> Visualize Chaos Experiment

website/versioned_docs/version-3.12.0/concepts/overview.md Outdated Show resolved Hide resolved
website/docs/concepts/overview.md Outdated Show resolved Hide resolved
@andoriyaprashant
Copy link
Contributor Author

Could you apply title capitalization to the text here?

Screenshot 2024-12-18 at 1 52 52 PM

Chaos infrastructure -> Chaos Infrastructure

ChaosHub

Chaos experiment -> Chaos Experiment

Resilience Probes

User management -> User Management

Projects

Teaming

GitOps

Authentication in ChaosCenter

Visualize chaos experiment -> Visualize Chaos Experiment

Oh, maybe I missed it. I'll change it right away

@andoriyaprashant
Update TOC and Overview
28a711c 
Signed-off-by: andoriyaprashant <[email protected]>
@andoriyaprashant
Changes
78864bb 
Signed-off-by: andoriyaprashant <[email protected]>
@andoriyaprashant
Sidebar
d3ea1e8 
Signed-off-by: andoriyaprashant <[email protected]>
namkyu1999
namkyu1999 approved these changes Dec 19, 2024
View reviewed changes
Copy link
Member

@namkyu1999 namkyu1999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@namkyu1999 namkyu1999 namkyu1999 approved these changes

@S-ayanide S-ayanide Awaiting requested review from S-ayanide

Assignees

@andoriyaprashant andoriyaprashant

Labels
techdocs-analysis
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make ToC agree with content headings
2 participants
@andoriyaprashant @namkyu1999