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

Split Helm doc sections for <= 24.08 and > 24.08 #128

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jdye64
Copy link
Collaborator

@jdye64 jdye64 commented Oct 2, 2024

Description

Make the documentation more clear around versions. Include specific instructions for using versions <= 24.08 and instructions for using > 24.08 since there are some notable differences between how the 2 are accessed and specifically around the nv-ingest-cli

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Copy link
Collaborator

@edknv edknv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have any minor versions between 24.08 and 24.09? If not, I wonder if <= 24.08 vs >= 24.09 (rather than <= 24.08 vs > 24.08) is clearer.

helm/README.md Outdated
Comment on lines 153 to 157
# Download the 24.08 .whl
wget https://github.com/NVIDIA/nv-ingest/releases/download/24.08/nv_ingest_client-24.08-py3-none-any.whl

# Pip install that .whl
pip install nv_ingest_client-24.08-py3-none-any.whl
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the versions be 24.09 not 24.08 in these commands?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or, looking at the instructions just above For versions > 24.08 we recommend building nv-ingest-cli from source to ensure you have the latest code, should it be pip install /path/to/nv-ingest/client?

Copy link

@dnola dnola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I followed this process after having difficulty with the current public docs and it worked great for me, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants