Skip to content

Quickstart and Prerequisites Instruction Suggestions #10

@kfirtoledo

Description

@kfirtoledo

Hi,
I wanted to share a few suggestions to improve clarity and consistency in the Quickstart and Prerequisites documentation:
Prerequisites Page:

  1. It’s a bit confusing that you mention using OpenShift 4.17.21, but later state that it's tested on 4.18.
  2. The command ./install-deps.sh is not clearly explained. First, it resides inside the quickstart folder, and also, there’s no prior instruction to clone the deployer Git repository.
  3. It should be clearly stated that the user must have admin privileges on the OpenShift cluster.
  4. Please remove references to quay and replace them with ghcr to reflect current usage.
  5. I appreciated the numbered list of dependencies—it adds clarity (though it's not strictly necessary).

Quick Start Installer:

  1. The requirements section repeats content already covered in the prerequisites. It would be better to link to that section instead of duplicating the information.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions