docs(helm): Document that admin tools don't work with K8s fs storage deployments.#2077
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughUpdated Kubernetes deployment and admin-tools documentation to reference explicit sbin scripts, add notes that Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/src/user-docs/reference-sbin-scripts/admin-tools.md (1)
148-151:⚠️ Potential issue | 🟡 MinorCross-reference doesn't point to the detailed explanation.
Same issue as with
archive-manager.sh: Line 151 references "note above" but that section doesn't contain details about the Kubernetes filesystem storage limitation. The detailed explanation is inguides-k8s-deployment.md(lines 447-451).📝 Suggested fix: Cross-reference to the K8s deployment guide
* `dataset-manager.sh` is not supported for Kubernetes (Helm) deployments when using filesystem - storage (`archive_output.storage.type: "fs"`). See the [note above](`#admin-tools`) for details. + storage (`archive_output.storage.type: "fs"`). See the [Kubernetes deployment guide](../guides-k8s-deployment.md#using-clp) for details.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/src/user-docs/reference-sbin-scripts/admin-tools.md` around lines 148 - 151, Update the cross-reference for the dataset-manager.sh note: replace the current "[note above](`#admin-tools`)" link (used in the Limitations paragraph referencing dataset-manager.sh and mirroring the archive-manager.sh issue) with a direct link to the Kubernetes deployment guide section that contains the detailed explanation of the filesystem storage limitation for Helm deployments (the K8s deployment guide section that explains archive_output.storage.type: "fs" not being supported). Ensure the new anchor/text points to that specific K8s deployment guide section so readers land on the detailed explanation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/src/user-docs/reference-sbin-scripts/admin-tools.md`:
- Around line 90-91: Replace the misleading "#admin-tools" cross-reference on
the `archive-manager.sh` note with a link to the Kubernetes deployment guide
that contains the detailed explanation (the section in guides-k8s-deployment.md
covering Docker bind mounts vs PVCs), or alternatively copy the brief technical
explanation about bind mounts vs PVCs directly into this file under the
`admin-tools`/`archive-manager.sh` note so the note explains why filesystem
storage isn't supported for Kubernetes deployments.
---
Duplicate comments:
In `@docs/src/user-docs/reference-sbin-scripts/admin-tools.md`:
- Around line 148-151: Update the cross-reference for the dataset-manager.sh
note: replace the current "[note above](`#admin-tools`)" link (used in the
Limitations paragraph referencing dataset-manager.sh and mirroring the
archive-manager.sh issue) with a direct link to the Kubernetes deployment guide
section that contains the detailed explanation of the filesystem storage
limitation for Helm deployments (the K8s deployment guide section that explains
archive_output.storage.type: "fs" not being supported). Ensure the new
anchor/text points to that specific K8s deployment guide section so readers land
on the detailed explanation.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: c0aaee3a-bac9-4c32-8000-2323881a7803
📒 Files selected for processing (2)
docs/src/user-docs/guides-k8s-deployment.mddocs/src/user-docs/reference-sbin-scripts/admin-tools.md
hoophalab
previously approved these changes
Mar 6, 2026
kirkrodrigues
approved these changes
Mar 6, 2026
junhaoliao
added a commit
to junhaoliao/clp
that referenced
this pull request
May 17, 2026
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
3 participants
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.
Description
As the title says. See the docs contents for details.
Checklist
breaking change.
Validation performed
The docs built and rendered without artifacts.
Summary by CodeRabbit