-
Notifications
You must be signed in to change notification settings - Fork 339
docs(26.05): split Charles deployment reconcile updates #2314
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,8 +7,8 @@ Typical order: | |||||
| 1. [Get your API key](api-keys.md) (NGC / API access as required by your workflow). | ||||||
| 2. Confirm the [Pre-Requisites & Support Matrix](prerequisites-support-matrix.md) for your OS, GPU, and software stack. | ||||||
| 3. Deploy using one of: | ||||||
| - [Deployment options](deployment-options.md) for how to run NeMo Retriever Library | ||||||
| - **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) for Kubernetes, plus [NeMo Retriever Library install docs](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) for the published charts | ||||||
| 4. Explore [Jupyter Notebooks](notebooks/index.md) for end-to-end examples. | ||||||
| - [Deployment options](deployment-options.md) for library, hosted NIMs, and Kubernetes paths | ||||||
| - **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) for Kubernetes cluster install and upgrade | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This getting-started page is for the 26.05 release flow, but the supported Helm chart link still opens the
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: docs/docs/extraction/getting-started-about.md
Line: 11
Comment:
**Pin release Helm link**
This getting-started page is for the 26.05 release flow, but the supported Helm chart link still opens the `main` branch. A new Kubernetes user can follow this first-run path, copy chart values or upgrade guidance added after 26.05, and apply settings that do not match the 26.05 chart. Point this link at the 26.05 branch so the release docs hand off to release-matched Helm docs.
```suggestion
- **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/26.05/nemo_retriever/helm/README.md) for Kubernetes cluster install and upgrade
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||
| 4. Explore [Jupyter Notebooks](starter-kits.md) for end-to-end examples. | ||||||
|
greptile-apps[bot] marked this conversation as resolved.
|
||||||
|
|
||||||
| If you are new to the product, read [What is NeMo Retriever Library?](overview.md) and [Concepts](concepts.md) under **Introduction** first. | ||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -48,6 +48,5 @@ NeMo Retriever Library supports the following file types: | |||||||||
| - [Pre-Requisites & Support Matrix](prerequisites-support-matrix.md) | ||||||||||
| - [Deployment options](deployment-options.md) — library, Helm, hosted vs self-hosted NIMs in one place | ||||||||||
| - [Deploy on Kubernetes with Helm](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) | ||||||||||
| - [NeMo Retriever Library — prerequisites / deployment](https://docs.nvidia.com/nemo/retriever/latest/extraction/overview/) (supported Helm charts) | ||||||||||
| - [Notebooks](notebooks/index.md) | ||||||||||
| - [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Integrations](integrations-langchain-llamaindex-haystack.md). | ||||||||||
| - [Notebooks](starter-kits.md) | ||||||||||
| - [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Starter kits](starter-kits.md). | ||||||||||
|
Comment on lines
+51
to
+52
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Both changed overview links now reference
Suggested change
Prompt To Fix With AIThis is a comment left during a code review.
Path: docs/docs/extraction/overview.md
Line: 51-52
Comment:
**Overview Links Target Missing Page**
Both changed overview links now reference `starter-kits.md`, which does not exist in `docs/docs/extraction/`. This can break the strict docs build and sends overview readers to a missing page instead of the existing notebooks and integration guidance.
```suggestion
- [Notebooks](notebooks/index.md)
- [NVIDIA AI Blueprints catalog](https://build.nvidia.com/explore/discover) — solution cards, enterprise RAG blueprints, and end-to-end patterns (including [Enterprise RAG — multimodal PDF data extraction](https://build.nvidia.com/nvidia/multimodal-pdf-data-extraction-for-enterprise-rag)); for integration pathways, refer to [Integrations](integrations-langchain-llamaindex-haystack.md).
```
How can I resolve this? If you propose a fix, please make it concise. |
||||||||||
Uh oh!
There was an error while loading. Please reload this page.