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]: Document that NGC urls in the current development branch point to unreleased containers #2113

Open
2 tasks done
dagardner-nv opened this issue Jan 16, 2025 · 0 comments
Labels
doc Improvements or additions to documentation

Comments

@dagardner-nv
Copy link
Contributor

How would you describe the priority of this documentation request

High

Describe the future/missing documentation

Due to the fact that our current development branch is always the default branch, new users encountering Morpheus through github reading the documentation are directed to fetch Morpheus containers from NGC which do not exist yet.
Ex examples/abp_nvsmi_detection/README.md

docker pull nvcr.io/nvidia/morpheus/morpheus-tritonserver-models:25.02

docs/source/getting_started.md

docker pull nvcr.io/nvidia/morpheus/morpheus:25.02-runtime

One potential solution could be adding a note at the top of README.md instructing the user that they are viewing the documentation for an unreleased version of Morpheus with a link to the latest official release in Morpheus. This could be templated in such a way that this could be incorporated into the ci/release/update-version.sh script.

Where have you looked?

examples/abp_nvsmi_detection/README.md
docs/source/getting_started.md

Code of Conduct

  • I agree to follow this project's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report
@dagardner-nv dagardner-nv added the doc Improvements or additions to documentation label Jan 16, 2025
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: Todo
Development

No branches or pull requests

1 participant