search

litmuschaos / litmus-docs

Documentation for the Litmus Project
https://docs.litmuschaos.io
Apache License 2.0
16 stars 78 forks source link

Remove obsolete websites #296

Open dwelsch-esi opened 1 week ago

dwelsch-esi commented 1 week ago

FEATURE REQUEST: Remove obsolete websites

A Google search turns up Litmus Chaos-branded websites that are obsolete and/or unexplained.

Remove or archive Litmus Chaos-related websites that are obsolete.

For any related documentation website that cannot be integrated into the existing doc repo, make sure there it has a clear explanation as to its purpose, use, and which version of Litmus Chaos it is compatible with.

Audience:

This issue concerns all users of the documentation.

Type:

This is an infrastructure issue that encompasses all the information on several websites.

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

GraphicQL API

The following API is one of the first hits on a search of "Litmus Chaos API": https://litmuschaos.github.io/litmus/graphql/v2.0.0/api.html.

I'm not even sure where the doc repo is (it might be in the API's repo here: https://github.com/litmuschaos/spectaql). It's clear this is a Litmus Chaos component, but not whether this documetnation is current or what it is for -- there's no introduction or explanation of the API.

Tutorials

The Litmus Chaos Tutorial website (https://litmuschaos.github.io/tutorials/; repo at https://github.com/litmuschaos/tutorials) seems to have been last updated in version 2. The first tutorial, "Getting Started", was last updated in August of 2021.

Having tutorials for the major workflows of Litmus Chaos is a great idea, but this site looks like it's been abandoned and I'd be nervous about trying the tutorials on it. Update the site to reassure readers that it's current, and link to it from the main documentation page. If it's too much work to update the whole thing, cannibalize it for the most useful workflows and delete the rest of the site. Or archive the entire site and move on.

Maintaining the project

It seems as if a lot of the information about Litmus Chaos that's online was either written by contributors not directly affiliated with the project or were initiated by the project and then abandoned. Going forward, we recommend two things:

  1. Maintainers keep tighter control of the Litmus Chaos brand (logo and trademarks) so that obsolete and unofficial information does not look like it's a current part of the project to casual observers. Use CNCF resources to help manage the brand, including website registration.
  2. Keep all documentation about the project up to date.
suhyenim commented 4 days ago

I would like to work on a PR to include the tutorial under the litmus-docs repo and plan to discuss related details in the upcoming contributor call.