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

Refactor documentation: Transfer Instructional Content from Concepts to User Guide for Improved Clarity #315

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Refactor documentation: Transfer Instructional Content from Concepts to User Guide for Improved Clarity #315

wants to merge 1 commit into from

Conversation

andoriyaprashant
Copy link
Contributor

What this PR does / why we need it:

This pull request addresses the feature request to reorganize the Litmus docs by consolidating instructional material into the User Guide and updating terminology for clarity. The following changes have been made:

  • Moved procedural content related to ChaosHub (connecting to Git repositories, syncing, editing, etc.), chaos experiments, and other instructional sections from the Concepts section to the User Guide.
  • Replaced the term "Prerequisites" with "Related concepts" in sections like Resilience Probe, GitOps, and Authentication to reflect conceptual content rather than actionable steps.
  • Renamed the "Collaborate with teams" section to "Team Collaboration" for consistency with documentation standards.

Which issue this PR fixes

Special notes for your reviewer:

Checklist:

@vercel Vercel
Copy link

vercel bot commented Dec 27, 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 27, 2024 2:58pm

@andoriyaprashant
Refactor documentation
922cac9 
Signed-off-by: andoriyaprashant <[email protected]>
@netlify Netlify
Copy link

netlify bot commented Dec 27, 2024 •
edited
Loading

✅ Deploy Preview for docs-litmuschaos ready!

Name Link
🔨 Latest commit 922cac9
🔍 Latest deploy log https://app.netlify.com/sites/docs-litmuschaos/deploys/676ebe6a31b77d00087a4a70
😎 Deploy Preview https://deploy-preview-315--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.

@andoriyaprashant andoriyaprashant mentioned this pull request Dec 27, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@divya-mohan0209 divya-mohan0209 Awaiting requested review from divya-mohan0209 divya-mohan0209 is a code owner

@ksatchit ksatchit Awaiting requested review from ksatchit ksatchit is a code owner

@k8s-dev k8s-dev Awaiting requested review from k8s-dev k8s-dev is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@andoriyaprashant andoriyaprashant

Labels
techdocs-analysis
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Move instructional material from Concepts to User Guide
2 participants
@andoriyaprashant @namkyu1999