-
Notifications
You must be signed in to change notification settings - Fork 130
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 fixes #147
Documentation fixes #147
Conversation
…e build, since we only generate them when doing an inplace build
…unclear on this, but the internet seems to imply that either include_package_data+MANIFEST.in or package_data should be used but not both
Co-authored-by: Christopher Harris <xixonia@gmail.com>
…s into david-cli-rel-paths
… convert to Git LFS
Co-authored-by: Devin Robison <drobison00@users.noreply.github.com>
…nto david-22.06-docs
I updated the pipeline graphs to include message types |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
David, I saw you started to add the NGC references to index.rst
which is aligned with what needs to happen to close out #92. Can you do one more pass over the repo with the changes requested in #92 so we can close that out as well with this PR?
To add a little more info, the README.md
and CONTRIBUTING.md
in the repo will be seen by developers and users before a release has happened. So there shoundnt be any references to NGC in these files and there shouldnt be any references to the current release (i.e. we want to avoid statement like pull nvcr.io/morpheus:v22.08
since 22.08 hasnt even shipped yet)
The corollary to this is the documentation in docs/*.rst
will be seen after a release has happened. And the user might be viewing these docs on docs.nvidia.com. So in these files, we dont want to make the assumption that the user has the repo cloned. So all references to things like ./docker/run_container_release.sh
should be removed in favor of the docker run ...
command. You already started doing some of this.
Let me know if you have any questions
…on docs.nvidia.com and should direct users to using the pre-built containers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Im still seeing references to NGC in the root README.md
…ation section to the CONTRIBUTING.md file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated the README with my last comments. Looks good now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@gpucibot merge |
Documentation updates to:
Fixes #92