-
Notifications
You must be signed in to change notification settings - Fork 79
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
Remove duplicate install instructions #298
Comments
Can you please assign this Issue to me. |
sure, @kef002 :) If there is no activity for two weeks, it may be assigned to someone else. |
@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! |
Hello @dwelsch-esi , if you have already made a lot of progress on this you can take over, if not, we can have a meeting tomorrow at 9am PST which will be 5 pm Dublin time and work on it together. |
I have already asked to be assigned to two other Issues, so If the time doesn't work for you, you can take over this Issue |
@kef002 I'm free tomorrow at 9 a.m. Can you please schedule a meeting and send me the invite? |
Hello @dwelsch-esi, set up the meeting for today. use the link below to access the meeting on zoom Charlotte is inviting you to a scheduled Zoom meeting. Topic: Remove duplicate install instructions #298 Meeting ID: 788 740 4995 |
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: