Skip to content

Documentation suggestion #2382

@jshawdell

Description

@jshawdell

Describe the bug
The Quick Install Guide (https://omnia-doc.readthedocs.io/en/latest/InstallationGuides/index.html), instructs the user to clone from main, rather than a specific release:

Clone the Omnia repository from GitHub on to the control plane, using the following command:
git clone https://github.com/dell/omnia.git

I have heard that it is more desirable for users to clone and install a specific release of OMNIA, so they have a known set of software components.

This suggestion is to change the install guide to instruct the user towards cloning the latest "release" rather than cloning main.

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions