Skip to content

Commit

Permalink
Fix issues with litmuschaos pages
Browse files Browse the repository at this point in the history
Signed-off-by: Patrice Chalin <pchalin@gmail.com>
  • Loading branch information
chalin committed Feb 25, 2025
1 parent 6dc4631 commit 97e7fbc
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 15 deletions.
12 changes: 5 additions & 7 deletions analyses/0013-litmuschaos/litmuschaos-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ tags: LitmusChaos
created: 2024-08-02
modified: 2024-10-09
author: Dave Welsch (@dwelsch-esi)
cSpell:ignore: Docusaurus rfc OSes pastable impl servicedesk md
---

<!-- markdownlint-enable line-length -->
<!-- cSpell:ignore Docusaurus rfc OSes pastable impl servicedesk md -->

<!-- markdownlint-disable no-duplicate-heading -->
<!-- markdownlint-disable no-duplicate-heading no-bare-urls -->

## Introduction

Expand Down Expand Up @@ -63,9 +61,9 @@ GitHub repo.

#### Out of scope

- Other LitmusChaos repos: <https://github.com/litmuschaos/>\*
- Other LitmusChaos repos: <https://github.com/litmuschaos/>
- Litmus Software (a completely unrelated company and product based in
Massachusetts): https://litmus.com/*
Massachusetts): <https://litmus.com/>

### How this document is organized

Expand Down Expand Up @@ -293,7 +291,7 @@ complete. For complex procedures, it's OK to link to sub-procedures or (usually
better) put preliminary tasks in the Prerequisites section.

Ensure that installation, setup, and verification have a clear, linked path for
each user role. See [New user content](#New-user-content) below.
each user role. See [New user content](#new-user-content) below.

Organize the User Guide by task. Some of the tasks will align with the current
function-based organization, but some will not. If necessary, split it into two
Expand Down
19 changes: 11 additions & 8 deletions analyses/0013-litmuschaos/litmuschaos-implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ things. Few recommendations here are meant to be prescriptive. Rather,
recommendations are based on documentation best practices as understood by the
reviewers. The recommended implementations represent the reviewers' experience
with how to apply those best practices. In other words, borrowing terminology
from the lexicon of [RFCs][rfc-keywords], the changes described here should be
understood as "recommended" or "should" at the strongest, and "optional" or
"may" in many cases. Any "must" or "required" actions are clearly denoted as
such, and pertain to legal requirements such as copyright and licensing issues.
from the lexicon of [RFCs][], the changes described here should be understood as
"recommended" or "should" at the strongest, and "optional" or "may" in many
cases. Any "must" or "required" actions are clearly denoted as such, and pertain
to legal requirements such as copyright and licensing issues.

## Implementation

Expand Down Expand Up @@ -129,7 +129,7 @@ There are at least four "getting started" links on the website.

| Link | Location | Refers to |
| --------------------------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
| _Get Started_ button | [Product landing page](https://litmuschaos.io/) | [GitHub repo]() |
| _Get Started_ button | [Product landing page](https://litmuschaos.io/) | [GitHub repo](https://github.com/litmuschaos/litmus) |
| _Get Started_ button | [Doc landing page](https://docs.litmuschaos.io/) | [ChaosCenter installation](https://docs.litmuschaos.io/docs/getting-started/installation) |
| _Getting Started_ link | [Doc landing page](https://docs.litmuschaos.io/) | [What is Litmus?](https://docs.litmuschaos.io/docs/introduction/what-is-litmus) |
| _Getting Started_ TOC entry | [Doc page](https://docs.litmuschaos.io/docs/) left-side menu | [ChaosCenter installation](https://docs.litmuschaos.io/docs/getting-started/installation) |
Expand Down Expand Up @@ -160,9 +160,10 @@ be its own page.

Ensure that installation, setup, and verification have a clear workflow. If
these instructions vary significantly between user roles, write a separate
workflow for each user role. See [New user content](#new-user-content) below.
Rename "Learn more" at the end of procedures and tasks to "Next steps". Explain
who would want to do each item and why in a short paragraph.
workflow for each user role. See
[New user content](litmuschaos-analysis.md#new-user-content). Rename "Learn
more" at the end of procedures and tasks to "Next steps". Explain who would want
to do each item and why in a short paragraph.

Limit on-site search to the current version of the documentation.

Expand Down Expand Up @@ -252,3 +253,5 @@ Consider adding links from the graphic elements on the project landing page.
Update or remove the CNCF announcement in the banner menu Community drop-down.

Implement analytics.

[RFCs]: https://www.rfc-editor.org/rfc/rfc2119
2 changes: 2 additions & 0 deletions analyses/0013-litmuschaos/litmuschaos-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Litmus Chaos Issue
tags: Litmus Chaos
---

<!-- markdownlint-disable line-length no-duplicate-heading no-bare-urls no-emphasis-as-heading -->

This document contains a list of issues to be entered in the Litmus Chaos
documentation repo more or less verbatim.

Expand Down

0 comments on commit 97e7fbc

Please sign in to comment.