docs(litmusctl): update create chaos experiment usage (closes #344) #367
+64
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…haos#344) Signed-off-by: vatsalm1611 <[email protected]>
vatsalm1611
requested review from
divya-mohan0209,
k8s-dev and
ksatchit
as code owners
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
✅ Deploy Preview for docs-litmuschaos ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
PriteshKiri
requested changes
Oct 10, 2025
| --- | ||
|
|
||
| ## litmusctl quick syntax |
There was a problem hiding this comment.
We don't need this syntax part as it is already covered in the previous doc. Start with step 1 directly.
|
|
||
| --- | ||
|
|
||
| ## 6. Verify the experiment & runs |
There was a problem hiding this comment.
Please remove everything after 5th step, as that content will go in the additional commands docs
| litmusctl save chaos-experiment -f custom-litmus-experiment.yaml --project-id "<project-id>" | ||
| ``` | ||
|
|
||
| --- |
There was a problem hiding this comment.
Please remove horizontal lines after each step
|
Got it, I'll make the requested changes. |
…eedback (keep only steps 1–5) Signed-off-by: vatsalm1611 <[email protected]>
|
Updated as per reviewer feedback ✅
Ready for re-review. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR updates the
website/docs/litmusctl/create-chaos-experiment.mdfile.Earlier it only had a short pointer link, now it includes a complete step-by-step guide for creating, saving, running and verifying Chaos Experiments using
litmusctl.Which issue this PR fixes (optional, in
fixes #<issue number>format):fixes #344
Special notes for your reviewer:
embedmdon docs before commit.Checklist:
documentationtag