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.

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

Improve Litmus documentation for Resilience probes #4378

Open
Saranya-jena opened this issue Jan 11, 2024 · 6 comments · May be fixed by litmuschaos/litmus-docs#250
Open

Improve Litmus documentation for Resilience probes #4378

Saranya-jena opened this issue Jan 11, 2024 · 6 comments · May be fixed by litmuschaos/litmus-docs#250
Assignees

Comments

@Saranya-jena
Copy link
Contributor

Here are few points where we can improve upon:

  • In resilience probe section we can add few points to mention that probe name is unique and can't be reused as it is an identifier. Deleting the probe will disable it not force delete it. - This can be updated in the documentation.
  • While creating an experiment , in user guide section we can add the step for probe addition and also mention that it is now mandatory.
  • In experiment creation we need a probeRef in annotations to add res probes (if constructing manually or uploading YAML). This can also be mentioned.
@anshikavashistha
Copy link

anshikavashistha commented Feb 19, 2024

@neelanjan00 @Saranya-jena May I work on this issue?

@Saranya-jena Saranya-jena changed the title Improve Litmus documentatiom for Resilience probes Improve Litmus documentation for Resilience probes Feb 19, 2024
@Saranya-jena
Copy link
Contributor Author

Hi @anshikavashistha sure, you can take it up. You will need to raise PR here: https://github.com/litmuschaos/litmus-docs

@anshikavashistha
Copy link

Surely
Thank you

@anshikavashistha
Copy link

@neelanjan00
Copy link
Member

https://github.com/amityt/litmus-docs-beta/blob/4efd5c3bd38339d4a6306b389cfcfc1871570ccd/website/docs/concepts/probes.md I think all the improvements should be updated there

No, please add it to the Resilience Probe section: https://docs.litmuschaos.io/docs/user-guides/create-resilience-probe

@anshikavashistha
Copy link

Sure @neelanjan00 I will add it to the Resilience Probe section
Thankyou

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants