Remove or reduce screen shots

[dwelsch-esi]

FEATURE REQUEST: Remove or reduce screen shots

Overview

There are many large screen shots in the User Guide procedures. These are problematic for several reasons:

• They take up a lot of space, pushing the actual text far down the page and increasing the need to scroll.
• They're difficult to keep up to date: The screenshot should be replaced anytime there's a change to the menu in question. This is often neglected, making the documentation inaccurate and in many cases confusing the reader.
• Screenshot text is not searchable.
• Screen shots are more expensive and difficult to translate than the equivalent text.

We recommend replacing the screen shots with text-based descriptions of the user options to be selected. If If an illustration is still required to point out a GUI element (it usually isn't), crop the screen shot to include the minimum required vertical height and use a drawing program to highlight the element in question.

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

Example:

Replace this:

with this:

and/or the following instruction:

"In ChaosCenter, go to the row representing the experiment you want to view on the Chaos Experiments page and select a highlighted experiment run box from the heatmap in the RECENT EXPERIMENT RUNS column."