docs(26.05): split Charles deployment reconcile updates#2314
Closed
kheiss-uwzoo wants to merge 3 commits into
Closed
docs(26.05): split Charles deployment reconcile updates#2314kheiss-uwzoo wants to merge 3 commits into
kheiss-uwzoo wants to merge 3 commits into
Conversation
Port Charles-owned deployment, FAQ, getting-started, and overview reconcile changes from PR 2311 onto 26.05. Includes branch-pinned Helm links for 26.05 release docs.
Contributor
Greptile SummaryThis PR updates the 26.05 extraction docs handoffs and guidance. The main changes are:
|
| Filename | Overview |
|---|---|
| docs/docs/extraction/deployment-options.md | Updates deployment guidance and several Helm-related links for the 26.05 docs. |
| docs/docs/extraction/faq.md | Clarifies captioning, Nemotron Parse, and environment variable guidance. |
| docs/docs/extraction/getting-started-about.md | Updates the getting-started deployment flow, but one Helm link still points at the development branch. |
| docs/docs/extraction/overview.md | Updates related topic links for deployment, notebooks, and starter content. |
Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
docs/docs/extraction/getting-started-about.md:11
**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
```
Reviews (2): Last reviewed commit: "Update docs/docs/extraction/deployment-o..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Comment on lines
+51
to
+52
| - [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). |
Contributor
There was a problem hiding this comment.
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.
Suggested change
| - [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). | |
| - [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). |
Prompt To Fix With AI
This 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.
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
| - **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.
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.
Suggested change
| - **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/main/nemo_retriever/helm/README.md) for Kubernetes cluster install and upgrade | |
| - **Supported:** [Helm chart](https://github.com/NVIDIA/NeMo-Retriever/blob/26.05/nemo_retriever/helm/README.md) for Kubernetes cluster install and upgrade |
Prompt To Fix With AI
This 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.
Collaborator
Author
|
Closing: no 26.5.0-valid delta after #2313; changes are main-only and introduce broken links. Triage vs upstream/26.05 (post-#2313):
Recommendation: keep 26.05 deployment/getting-started/overview pages as shipped; do not port main IA here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Review context
This is part of the owner-based split of #2311 so previous contributors can review their own 26.05 reconcile changes.
Test plan
upstream/26.05: one commit, intended docs files only.