Skip to content

Mark a clear "getting started" path #297

Open
@dwelsch-esi

Description

@dwelsch-esi

FEATURE REQUEST: Mark a clear "getting started" path

Overview

There are at least four "getting started" links on the website. To avoid confusing users, make them all point to the same place, or relabel them so they more accurately reflect the linked content.

The idea is to funnel new users to the Getting Started page, where they can focus uninterrupted on a streamlined procedure for installing and testing the product.

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 links are all labeled "Getting Started" but lead to different pages:

  1. The Get Started button in the Product landing page banner menu
    points to the GitHub repo.

    Recommendation: Re-label the button "Learn more" or "Go to documentation".

  2. The Get Started button on the Product landing page
    points to the GitHub repo.

    Recommendation: Re-label the button "Learn more" or "Go to documentation".

  3. The Get Started button on the Doc landing page
    points to ChaoCenter installation.

    Recommendation: Re-label the button "Learn more" or "Go to documentation". Or, remove this button since the very next section starts with a link to the installation documentation.

  4. The Getting Started link on the Doc landing page
    points to What is Litmus?.

    Recommendation: Leave as is. But, reorganize the Installation/Getting Started section in the documentation table of contents (see the next item).

  5. The Get Started table of contents (TOC) entry in the Doc page left-side menu
    expands the section's options in the TOC.

    Recommendation: Remove the "Resources" section (that material is covered elsewhere, in "Architecture" and "Concepts"; add a link to that explanation instead). The "Installation" page is a good workflow for beginners to get through installation, configuration, and starting to use the product. Move the contents of the "Installation" page up so that it's a standalone entry called "Getting Started". Move that section to the top of the TOC.

  6. The Getting started tutorial
    is a standalone tutorial that provides an end-to-end path for a beginner to install, validate, and run Litmus and execute a chaos experiment.

    Recommendation: Link to the tutorial from the main website. Also, see the issue about updating and maintaining the tutorials and other Litmus-branded websites: Remove obsolete websites #296.

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions