Skip to content
New issue

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

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

Already on GitHub? # to your account

Reorganize Getting Started and concepts Sections in Docs #305

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

Conversation

andoriyaprashant
Copy link
Collaborator

What this PR does / why we need it:

This PR updates the Litmus Chaos documentation to streamline the user experience and align with the recommended changes from the feature request. It involves reorganizing the Installation/Getting Started section in the table of contents and removing the 'Resources' section. The content from resources.md has now been moved to concepts/chaos-center.md for better organization. Additionally, the 'Getting Started' link on the Doc landing page is maintained as-is, while the 'Installation' page content is moved up to create a standalone 'Getting Started' section in the TOC

For points 1 and 2, see the related PR in the litmus-website-2 repository: litmuschaos/litmus-website-2#121

Which issue this PR fixes : fixes #297

Special notes for your reviewer:

Checklist:

Copy link

vercel bot commented Nov 22, 2024

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 Nov 30, 2024 11:19am

Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for docs-litmuschaos ready!

Name Link
🔨 Latest commit fd3cea3
🔍 Latest deploy log https://app.netlify.com/sites/docs-litmuschaos/deploys/674af3f04f07db0008c47a27
😎 Deploy Preview https://deploy-preview-305--docs-litmuschaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@namkyu1999
Copy link
Member

@andoriyaprashant ,

We already have a chaos infrastructure section, so why not integrate this part into that section?

Rest looks good to me 👍

@andoriyaprashant
Copy link
Collaborator Author

@andoriyaprashant ,

We already have a chaos infrastructure section, so why not integrate this part into that section?

Rest looks good to me 👍

Done @namkyu1999

Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>
Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>
Signed-off-by: andoriyaprashant <prashantandoriya@gmail.com>
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 🚀 we can merge this pr after one more maintainer's review :)

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

Successfully merging this pull request may close these issues.

Mark a clear "getting started" path
2 participants