LFX mentorship (2025/Term-1): Expanding the LitmusChaos Tutorials - Day 0, Day 1, and Day 2 User Flows

[S-ayanide]

Description

This task focuses on improving the LitmusChaos documentation by structuring and creating tutorials into Day 0, Day 1, and Day 2 workflows tailored for different users. Instead of documenting individual faults (which would require constant maintenance), the goal is to create user-flow-based guides that help users understand chaos engineering principles at different levels of expertise, from beginners experimenting with sample apps to advance users implementing chaos in real-world systems.

Additionally, this task will involve tech doc improvements, fixing structural issues, removing duplicates, and ensuring a clear and intuitive documentation experience for the community.

Prerequisites:

• Strong technical writing and research skills.
• Ability to understand user personas (SREs, Principal Engineers, Developers, etc.).
• Familiarity with chaos engineering principles (experience with LitmusChaos is a plus).
• Basic knowledge of Kubernetes and observability tools (Grafana, Prometheus, etc.).

Schedule: 3rd March, 2025 - 30th May, 2025

Previous Works & References:

• Existing LitmusChaos Documentation: LitmusChaos Docs
• GitHub Issues for Documentation Improvements: LitmusChaos Docs Repo
• Example Tutorials in the Current Docs: LitmusChaos Tutorials

What You Will Do:

1. Develop Day 0, Day 1, and Day 2 Tutorials for LitmusChaos

• Day 0 (Beginner-Level Chaos Engineering) [Already implemented, we can improve it further]
  Goal: Introduce users to chaos engineering with a simple application.
  Application: Podtato Head, Online Boutique, or another microservices demo app.
  Experiment: Simulate pod deletion and observe recovery through Kubernetes deployment strategies.
  Outcome: Understand basic failure scenarios and how Kubernetes ensures resilience.

• Day 1 (Intermediate-Level Chaos Engineering)
  Goal: Introduce chaos into real-world applications with stateful components.
  Application: Redis, Cassandra, or MongoDB.
  Experiment:

  • Simulate leader pod crashes to test leader-election mechanisms.
  • Perform network partitioning to evaluate how replicas handle failures.
    Outcome: Learn how distributed databases and services handle failures.

• Day 2 (Advanced Chaos Workflows & Multi-Experiment Scenarios)
  Goal: Create a comprehensive chaos engineering workflow from start to finish.
  Scenario: A complex chaos workflow covering multiple failure scenarios.
  Experiments:

  • Pod delete → CPU spike → Network latency → Validate system recovery metrics in Grafana.
  • Extend this to multi-cluster failure scenarios for advanced users.
    Outcome: Understand system-wide resilience patterns and how to build automated chaos workflows.

2. Research Chaos Experiment Needs for Different Personas
   Identify use cases for different users (SREs, Platform Engineers, Principal Engineers).
   Determine the right type of experiments and use case tutorials for the group.

3. Improve Documentation Structure and Fix Issues
   Work on fixing tech docs analysis open issues (structure changes, removing duplicates, improving clarity).
   Enhance navigation and make tutorials easier to follow.

Mentors

• @S-ayanide
• @SmritiSatya

This task is ideal for those passionate about developer experience, documentation, and chaos engineering education. The tutorials created will serve as long-term learning resources for new and experienced LitmusChaos users!

[DeshDeepakKant]

Hi @S-ayanide,

I am highly interested in this mentorship opportunity as it aligns perfectly with my skills and interests. I have experience with technical writing, Kubernetes, and observability tools like Grafana and Prometheus. Additionally, I am familiar with chaos engineering principles and have worked on improving documentation for developer-focused projects.

I am eager to contribute to expanding the LitmusChaos tutorials and enhancing the user experience through well-structured documentation. Looking forward to any guidance or next steps to get started!

[Satarupa22-SD]

Hi @S-ayanide @SmritiSatya,

I am really interested in this project. I have prior experience with software documentation, tutorials and I am currently volunteering as a writer in the IAM whitepaper under TAG Security, CNCF. This project perfectly aligns with my skills and expertise.

Could you provide guidance on the key aspects I should focus on to strengthen my application? Should I prioritize increasing my contributions to the project by solving issues, or should I concentrate on developing a strong proposal and implementation plan? I’d be extremely grateful for any advice you can offer.

Thank you!
I look forward to making a meaningful contribution.

[CI-CDee]

Hi @S-ayanide, I am really interested in this project, and it aligns well with my skills. I have a doubt about the writing sample submission. Can you clarify what kind of sample we can provide, the word limit, and other details about it? Can I submit a blog (as I frequently write technical blogs) ?

[larymak]

Hi @S-ayanide, @SmritiSatya

I’m interested in this project as it aligns well with my experience in technical writing, structuring developer documentation, and simplifying complex technical concepts. I’ve worked on projects that involve creating structured tutorials, improving documentation clarity, and ensuring a seamless user experience for different personas.

I’d love to work on improving the documentation structure, fixing existing issues, and enhancing navigation to make learning LitmusChaos more intuitive.

Could you provide guidance on any specific areas where contributions are most needed? Should I prioritize researching user personas for chaos experiments, refining existing tutorials, or tackling structural documentation issues?

Looking forward to your insights and the opportunity to contribute!

[CaptainBKola]

Hi @S-ayanide, I have 4 years experience in tech, I have been working as backend engineer, DevOps and technical writer. I am interested in this role. I look forward to hearing back from you.

[kelvinmburu]

Hello @S-ayanide

I'm interested in this mentorship project. I have 3 years of experience in technical writing, majoring in frontend development and API documentation. Here's a link to my blog.

I'm gradually moving to high-level technical writing, which is why this opportunity aligns with my skills and career goals. Could you offer guidance on the next steps? Should I immediately start working on the issue? I'd appreciate your guidance on the way forward.

Looking forward to your feedback. Thanks.