You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rather than duplicating information in different scenarios (basic vs. advanced install), rewrite the pages so that no duplication is necessary.
The same applies to anywhere documentation has been duplicated by cut-and-paste.
There are several ways to do this:
Consolidate the pages so that the separate information is subordinate to the duplicated information rather than vice versa.
Put the duplicated material on its own page and link to it. This solution assumes that making the user click to a common piece of information is a lesser liability than trying to maintain the same information in two (or more) places. It usually is.
Put the dupilcate information on its own page and include in-line everywhere it's required (not easy to do here, since Markdown doesn't have a mechanism for that like the Restructured Text ".. include" directive.)
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.
Instead, consider consolidating the basic and advanced install onto one page using the following outline:
Installation (one page for both basic and advanced installation)
Prerequisites
(the following two items could be in clickable tabs, or one after the other with a note to skip the one you don't use.)
Install Litmus using Helm
Install Litmus using kubectl
(the following two items could be in clickable tabs, or one after the other with a note to skip the one you don't use.)
Basic install
Advanced install
Verify your installation
Accessing ChaosCenter
Alternatively, each main bullet item could be its own page, and each page linked to from its predecessor's "Next steps" heading at the end of the procedure.
The text was updated successfully, but these errors were encountered:
@kef002 I've been looking at this, and have a draft of a new install page done. I'd be happy to turn it over to you, to have you test the install, or collaborate in any other way you'd like. Please let me know what you'd like to do.
Hello @dwelsch-esi , we can collaborate on this, I am going for Christmas Holidays on the 23rd and Will be back on the 2nd of January we can sync up on a call before I leave.
@kef002, There's not a lot of time to connect before the 23rd. Please let me know your availability. I'm in California, so PST time zone. Otherwise, have a great holiday and let's talk after the new year!
FEATURE REQUEST: Remove duplicate install instructions
Overview
Rather than duplicating information in different scenarios (basic vs. advanced install), rewrite the pages so that no duplication is necessary.
The same applies to anywhere documentation has been duplicated by cut-and-paste.
There are several ways to do this:
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 sections (and possibly others) are duplicated between the Basic Install and Advanced Install:
Instead, consider consolidating the basic and advanced install onto one page using the following outline:
(the following two items could be in clickable tabs, or one after the other with a note to skip the one you don't use.)
(the following two items could be in clickable tabs, or one after the other with a note to skip the one you don't use.)
Alternatively, each main bullet item could be its own page, and each page linked to from its predecessor's "Next steps" heading at the end of the procedure.
The text was updated successfully, but these errors were encountered: