Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation suggestion #2382

Open
jshawdell opened this issue Nov 25, 2024 · 1 comment
Open

Documentation suggestion #2382

jshawdell opened this issue Nov 25, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@jshawdell
Copy link

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.

@jshawdell jshawdell added the bug Something isn't working label Nov 25, 2024
@abhishek-sa1
Copy link
Contributor

@jshawdell User can always clone latest omnia release from GitHub. We are not specifying the version because main has stable version of Omnia. In every new release of omnia, main branch will be updated. Release branches can be used, but it will be a work in progress branch. For stable releases, any omnia tagged build can be used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants