Skip to content

Clean up Quick Start (Extended) Documentation #644

Description

@milanvujinovic

General

  • Offer option in the guide to choose between linux or macos variants of guide.

Introduction

  • The subtitle (greyed out text) at the top can be made like:
    "Looking for a shorter guide? See the...."
  • E2E test suite mentioned but this was never mentioned previously.

Prerequisites

  • "Required and optional tools" should use same structure as QuickStart Guide on the required tools. Mention optional only as an aside, not in the same table as required.
  • Mentions docker but guide offers podman as well, seems to be only for linux, while Docker is for macos.
  • Text from "The project ships a helper script that downloads and verifies ..." until the command to export PATH should be moved at the end of step 1, after checking out the repo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions