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

[DOC] Add NGC references back to README #92

Closed
BartleyR opened this issue May 6, 2022 · 1 comment · Fixed by #147
Closed

[DOC] Add NGC references back to README #92

BartleyR opened this issue May 6, 2022 · 1 comment · Fixed by #147
Assignees
Labels
doc Improvements or additions to documentation

Comments

@BartleyR
Copy link
Contributor

BartleyR commented May 6, 2022

Report needed documentation
We removed the NGC references from the getting started section temporarily as to avoid confusion on the multiple paths to get started. The removed link directed users here: https://catalog.ngc.nvidia.com/orgs/nvidia/teams/morpheus/collections/morpheus_. This is where a user would go if they want to use Helm charts to run Morpheus in a K8s environment.

Describe the documentation you'd like
This link and wording around it should be added back into the README.md file once we can decide on the wording to avoid potential confusion with users mixing and matching paths to get started.

@BartleyR BartleyR added doc Improvements or additions to documentation Needs Triage Need team to review and classify labels May 6, 2022
@BartleyR BartleyR self-assigned this May 6, 2022
@mdemoret-nv
Copy link
Contributor

To be clear, this issue should separate the documentation pieces that should be seen only after release from the pieces that are seen during development. This means:

  1. Remove all references of NGC and pre-built containers from the root README
  2. Add the NGC references to the root of the docs/index.rst
  3. Add a link to NGC in each of the releases pages
  4. Ensure all version numbers match in the repo

@mdemoret-nv mdemoret-nv removed the Needs Triage Need team to review and classify label May 10, 2022
@mdemoret-nv mdemoret-nv assigned mdemoret-nv and unassigned pdmack and BartleyR May 10, 2022
@mdemoret-nv mdemoret-nv linked a pull request Jun 28, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants