Description
FEATURE REQUEST: Single-source Litmus Chaos documentation
Overview
One of the CNCF guidelines for technical documentation is that it have a single source. The Litmus Chaos technical documentation is spread over several repos, which makes it harder to maintain. Some of the repos are obsolete; these should be retired and archived or deleted.
Consolidate the documentation so that it is maintained in a single repo. If this is not practical for some of the repos (it might be difficult to move the API doc, for example, if it is generated from code), then document their location in the README file in the main documentation repo. Make it clear which repos are active and which are retired.
Use a single website technology stack for the entire site if possible.
Audience:
This issue concerns all users of the documentation.
Type:
This is an infrastructure issue that encompasses all the information on several websites.
Context
This issue tracks recommended changes resulting from an analysis of the Litmus Chaos
documentation commissioned by CNCF. The analysis and supporting documents are
here: https://github.com/cncf/techdocs/tree/main/analyses under 0013-litmuschaos.
Possible Implementation
The following repos are affected:
| Repo URL | Description | Recommendation |
|---|---|---|
| https://github.com/litmuschaos/litmus-website-2 | The project website repo | Combine with the doc repo |
| https://github.com/litmuschaos/litmus-docs | Documentation repo | Combine with the website repo |
| https://github.com/litmuschaos/v1-litmus-docs | Another documentation repo, for docs before 2.0 | Retire and archive. |
| https://github.com/litmuschaos/website-litmuschaos | Previous website repo | Already archived. Include the new repo's URL in the archive announcement banner. |
| https://github.com/litmuschaos/tutorials | Tutorials repo | Update. Combine with documentation repo. |