Add "Tutorials" sidebar and create new podtato-head tutorial #302
Conversation
Signed-off-by: Suhyen Im <[email protected]>
Signed-off-by: Suhyen Im <[email protected]>
suhyenim
requested review from
divya-mohan0209,
ksatchit and
k8s-dev
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
✅ Deploy Preview for docs-litmuschaos ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|  | ||
|
|
||
| ## Run Chaos Experiment with Podtato-head | ||
| 1. For Kubernetes v1.24 or later, bind a ClusterRole to the `argo-chaos` service account |
There was a problem hiding this comment.
why are we binding argo-chaos serviceAccount to admin cluster-role?
There was a problem hiding this comment.
Starting with Kubernetes v1.24, service accounts no longer receive tokens automatically upon creation. To provide the necessary permissions to the argo-chaos service account, we initially bound it to the admin cluster role. However, since this cluster role grants excessively broad permissions, it would be more appropriate to assign a role specific to the litmus namespace instead.
Additionally, please note that with the recent update to the tutorial, this step is now unnecessary.
|
Rather than using the existing template, it would be a good idea to add a brief description of podtato-head and write a tutorial that goes through installing the podtato-head application and experimenting with pod delete. WDYT? |
Signed-off-by: Suhyen Im <[email protected]>
I think it's a great idea! I’ve updated the |
| sidebar_label: Podtato-head | ||
| --- | ||
|
|
||
| --- |
There was a problem hiding this comment.
We can remove this and say ##Introduction
There was a problem hiding this comment.
I’ve updated the sidebar_label based on your suggestion. Please check the latest commit.
|
|
||
|  | ||
|
|
||
| --- |
There was a problem hiding this comment.
We can remove this, and say ##Conclusion.
There was a problem hiding this comment.
Is this review suggesting to remove the image experiment-result, or to change the subheading above it, ##Check Chaos Experiment Results?
| --- | ||
|
|
||
| Congratulations! 🎉 You've successfully completed the tutorial. | ||
| Continue exploring more tutorials to enjoy your journey with LitmusChaos! 🚀 |
There was a problem hiding this comment.
We can link to other tutorials if any or some more feature docs too.
There was a problem hiding this comment.
I’m planning to create and upload another tutorial after this PR. So once this tutorial is merged, I’ll update it to mention the new one.
Signed-off-by: Suhyen Im <[email protected]>
|
Looks good to me, thank you @suhyenim |
Signed-off-by: Suhyen Im <[email protected]>
suhyenim
changed the title
There was a problem hiding this comment.
Since we plan to add more tutorials, how about creating an 'Overview' tab and renaming 'Introduction' to 'Let's Start with Podtato-head'? This change aligns with this issue (#300).
Signed-off-by: Suhyen Im <[email protected]>
Signed-off-by: Suhyen Im <[email protected]>
Signed-off-by: Suhyen Im <[email protected]>
Sure! That sounds like a great idea. I’ve updated the commit with your suggestion😄 |
What this PR does / why we need it:
This PR implements two features:
Tutorialssidebar to Litmus Docs.Which issue this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close that issue when PR gets merged): fixes tutorial issue on #296Special notes for your reviewer:
Checklist:
documentationtag