docs: address #137 follow-ups (helm install, key-manager API, anchors, gpu-operator note)#142
Merged
Conversation
…evocation, index links, spec.access anchor, gpu-operator note)
|
📄 Docs preview for |
…key revocation (review feedback)
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.
Addresses the open follow-ups in #137.
Done in this PR
cicd-and-releasing.md):helm installfrom the published OCI chart (oci://quay.io/nebari/charts/nebari-llm-serving --version 0.1.2) and via the gh-pages Helm repo, for local/manual installs (ArgoCD stays the recommended path).quickstart.mdx): aPOST /api/keyscurl with a bearer JWT, as a CLI alternative to the UI.quickstart.mdx): UI delete orDELETE /api/keys/{namespace}/{model}/{clientID}; a revoked key immediately 401s on the external route.index.md): link the runnableexamples/models/*.yamlmanifests from the teaser.#specaccessanchor fix (configuration.mdx): renamed the PassthroughModel### spec.accessto### spec.access (external provider)so the LLMModel#specaccessanchor (and the in-page cross-link) is unambiguous regardless of heading order.installation.md): documents when to use the installation.md config (vanilla GPU nodes, operator installs driver + toolkit) vsexamples/nvidia-gpu-operator.yaml(pre-installed NVIDIA driver AMI, driver + toolkit disabled).Already resolved (not in this PR)
The "version source of truth" item is resolved by the release-automation migration:
Chart.yamlis now the single source of truth (bumping it drives the release), currently0.1.2, so the oldalpha.9-vs-git-tag drift is gone.Docs build clean;
docs-examplestests 25/25; link check OK; no em dashes.