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

Jump to bottom

m-agent User Docs #185

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

m-agent User Docs #185

wants to merge 4 commits into from

Conversation

neelanjan00
Copy link
Member

Why We Need This PR

Adds m-agent user docs

Which Issue This PR Fixes

fixes #184

Checklist:

  • Fixes #
  • Signed the commit for DCO to be passed
  • Labelled this PR & related issue with documentation tag

@neelanjan00
added overview of m-agent
1721b3f 
Signed-off-by: Neelanjan Manna <neelanjan.manna@harness.io>
@neelanjan00
added installation, uninstallation, and usage docs
3006837 
Signed-off-by: Neelanjan Manna <neelanjan.manna@harness.io>
@neelanjan00
embedmd updated
03e7a24 
Signed-off-by: Neelanjan Manna <neelanjan.manna@harness.io>
@neelanjan00 neelanjan00 added documentation Improvements or additions to documentation DO NOT MERGE labels May 11, 2022
@neelanjan00 neelanjan00 self-assigned this May 11, 2022
@neelanjan00 neelanjan00 requested a review from k8s-dev as a code owner May 11, 2022 05:53
@netlify
Copy link

netlify bot commented May 11, 2022 •
edited
Loading

❌ Deploy Preview for litmus-docs-411023 failed.

Name Link
🔨 Latest commit 5180c54
🔍 Latest deploy log https://app.netlify.com/sites/litmus-docs-411023/deploys/627cba4ed6e4950009ac5361

avaakash
avaakash requested changes May 11, 2022
View reviewed changes
@avaakash
Copy link

In the diagram should we also mention network, as m-agent can be used to inject chaos into the network of the host? Ref: https://github.com/litmuschaos/litmus-docs/blob/03e7a240d1211e04b526aea4cc19b1764f4cb899/website/docs/assets/m-agent-design.png

@neelanjan00
Copy link
Member Author

In the diagram should we also mention network, as m-agent can be used to inject chaos into the network of the host? Ref: https://github.com/litmuschaos/litmus-docs/blob/03e7a240d1211e04b526aea4cc19b1764f4cb899/website/docs/assets/m-agent-design.png

We can do that potentially, but it might make the diagram somewhat crowded. We can also think of some other design for the diagram. CC: @uditgaurav @ksatchit

@neelanjan00
grammatical fixes
5180c54 
Signed-off-by: Neelanjan Manna <neelanjan.manna@harness.io>
avaakash
avaakash approved these changes May 12, 2022
View reviewed changes
Copy link

@avaakash avaakash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, we can improve the diagram at later stages.

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@avaakash avaakash

@divya-mohan0209 divya-mohan0209

@ksatchit ksatchit

@k8s-dev k8s-dev

Assignees

@neelanjan00 neelanjan00

Labels
DO NOT MERGE documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add m-agent User Documentation
2 participants
@neelanjan00 @avaakash