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

Integrate the overview material #308

Open
Tracked by #294
dwelsch-esi opened this issue Dec 4, 2024 · 0 comments
Open
Tracked by #294

Integrate the overview material #308

dwelsch-esi opened this issue Dec 4, 2024 · 0 comments

Comments

@dwelsch-esi
Copy link

FEATURE REQUEST: Integrate the overview material

Overview

The following reorganization is suggested:

Move the "Architecture" and "Concepts" section to follow the "Introduction" section. Integrate Concepts and Architecture to reference each other's content for a more complete picture of the system.

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

Concepts and Architecture could be integrated into one description of Litmus Chaos. Both are good but separate views into the working of Litmus Chaos. "Architecture" describes the separation of the control and execution planes and provides sequence diagrams of the Chaos processes; "Concepts" describes the logical entities that make up the Chaos process. It would be helpful if these two descriptions referenced each other. For example, a section on a Concept could point out which steps in the sequence diagram the entity is involved in.

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

No branches or pull requests

2 participants