Skip to content

Commit c10a8e4

Browse files
author
Karthik Satchitanand
authored
(chore)GSoD: Project Proposal Page (litmuschaos#2603)
* (chore)GSoD: Project Proposal Page Signed-off-by: ksatchit <[email protected]> * (chore)GSoD: Clarify scope of work and provide budget info Signed-off-by: ksatchit <[email protected]>
1 parent 87e86fd commit c10a8e4

File tree

1 file changed

+90
-0
lines changed

1 file changed

+90
-0
lines changed

GoogleSeasonOfDocs.md

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# GSoD @LitmusChaos
2+
3+
## Introduction
4+
5+
Hello All! This doc contains the "project proposal" for LitmusChaos's participation in the 2021 [Google Season of Docs](https://developers.google.com/season-of-docs). We look forward to a productive and fun experience working with the technical writers that come on board!
6+
7+
## About LitmusChaos
8+
9+
Litmus is a Cloud-Native Chaos Engineering platform that helps SREs & Developers identify and fix weaknesses in their system. It is a CNCF
10+
Sandbox project with adoption across several organizations. Litmus has a thriving community that lives in [Kubernetes Slack](https://kubernetes.slack.com/?redir=%2Farchives%2FCNXNB0ZTN). You can find out more about Litmus and it's evolution from the [blog](https://dev.to/t/litmuschaos) or [videos](https://www.youtube.com/playlist?list=PLmM1fgu30seVGFyNIEyDgAq6KnzgW2p3m).
11+
12+
## State of LitmusChaos Documentation
13+
14+
The steps for getting started with Litmus & procedure for running individual chaos experiments are available in the [Docs Website](https://docs.litmuschaos.io). The Litmus architecture is available in the [Wiki](https://github.com/litmuschaos/litmus/wiki/Litmus-Architecture), with contribution docs
15+
spread across the different sub-projects/repositories contained within the [LitmusChaos](https://github.com/litmuschaos) GitHub organization. This includes
16+
guides detailing how developers can contribute to the [Chaos Experiment suite](https://github.com/litmuschaos/litmus-go/tree/master/contribute/developer-guide) and the [documentation](https://github.com/litmuschaos/litmus-docs/blob/master/CONTRIBUTING.md) itself.
17+
18+
Like minded folks from the community interested in improving documentation have formed a special interest group (SIG-Docs), that meets at every Monday @8PM IST on the community [zoom meet](https://zoom.us/j/91358162694).
19+
20+
Litmus is undergoing a major version change (to 2.0. Currently in beta). The community plans to move to Docusaurus-2 as the platform of choice for hosting the documentation.
21+
22+
## Project Idea: Create Tutorials for Litmus 2.0
23+
24+
### Problems
25+
26+
- The current docs are helpful for intermediate-level chaos-practitioners. We still lack enough simple, easy-to-navigate guides that help beginners
27+
or support quick evaluation.
28+
- Litmus 2.0 offers a newer approach to chaos experimentation compared to the 1.x releases. It uses a portal/dashboard driven approach that allows for
29+
several user flows. These are still not documented.
30+
- Litmus integrates with a wide-variety of tools/frameworks in the CNCF ecosystem - monitoring tools, CI/CD systems etc., which are not documented fully
31+
32+
### Scope of Work
33+
34+
One of the solutions mooted by the community and maintainers team is to create an initial set of "tutorials" based on [GoogleCodeLabs](https://github.com/googlecodelabs/tools) for a list of common user flows - that include usage of the litmus portal (2.0) & integration with other cloud native tools. These tutorials will be featured on the LitmusChaos project/docs website.
35+
36+
While the existing documentation framework (and upcoming one based on docusaurus-2) is expected to contain architecture, experiment and other conceptual
37+
details that will help intermediate-level/advanced chaos practitioners build out their usecases, the tutorials are expected to be what the users will most
38+
benefit from to get started and familiarize themselves with Litmus.
39+
40+
The GSoD collaborator is expected to work on tutorials in the following areas and publish them, while setting up the source artifacts for further scale
41+
and easy contributions from the community.
42+
43+
- How to Get Started: Installation of Litmus via Helm, Portal Set-up, Execution of a Simple Chaos Worflow on a local/remote Target
44+
- How to Construct Custom Chaos Workflows (Using Portal, LitmusCtl)
45+
- How to create teams & manage users
46+
- How to enable GitOps driven Chaos Workflow Management and Execution
47+
- How to Visualize Chaos Using Chaos-Interleaved Application Dashboards
48+
- How to setup Automated Hypothesis Validation using Litmus Probes
49+
- How to use Resilience Grading & Chaos Analytics
50+
- How to Integrate with Gitlab, GitHubActions, Spinnaker, Keptn
51+
52+
### How would we measure success
53+
54+
- Decrease in the number of basic usage related questions on the slack community
55+
- Decrease in the number of GitHub issues related to queries/missing information
56+
- Better SEO for LitmusChaos related concepts
57+
- Increase in non-code/docs contributors to enhance the tutorials (improvements to existing ones or contribute new ones)
58+
59+
### Skills Needed
60+
61+
- The participant is expected to be comfortable in following steps/docs provided by the Litmus developers, following instructions to test them
62+
for correctness & re-write in the tutorial format. This involves basic Git usage, setting up a local development environment for docs and using
63+
a Kubernetes cluster (the instructions and assistance for last requirement will be provided by a volunteer team from the community)
64+
65+
### Budget Details
66+
67+
|Budget Item|Amount(in USD)|Running Total| Notes |
68+
------------|------|-------------|-------|
69+
|Tutorials Creation for Litmus 2.0| 6000.00 | 6000.00 | |
70+
|Volunteer Stipends | 500 | 8000.00 | 4 volunteer stipends x 500 each |
71+
|**Total** | | 8000.00 | |
72+
73+
### Mentors Team
74+
75+
You can reach out to following folks from the LitmusChaos community for queries & assistance
76+
77+
- [email protected] (@ksatchit)
78+
- [email protected] (@rajdas98)
79+
- [email protected] (@k8s-dev)
80+
- [email protected] (@divya-mohan0209)
81+
82+
### Contact Info
83+
84+
Technical Writers interested in this project can reach out by sending an email to the following folks. Please include links to your technical writing
85+
work or portfolio/CV
86+
87+
88+
89+
90+

0 commit comments

Comments
 (0)