docs: move the model store and model deployment pages into domain dirs - #694
Merged
Merged
Conversation
Both domains sat flat in docs/reference/, a directory the conventions define as lookup tables with provenance; fourteen pages of contracts, field references, views and a runbook had made it the dumping ground the kv-cache split avoided. They now live in docs/model-store/ and docs/model-deployment/ under short file names whose H1s carry the domain prefix, the way kv-cache pages do; docs/reference/ keeps the four true lookup pages that remain. Every pin on a page path rides along: the owned-key test's _ModelDeploymentDocsPath, the api comment that generation copies into the proto, OpenAPI and applyconfiguration artifacts (regenerated), the docs skill's routing table, page map and conventions, the overview and e2e skills, and every cross-link and label. specs/ records stay untouched, as the docs skill requires of historical records.
|
✅ OpenCodeReview: Review complete: 0 finding(s) across 1 selected item(s). Reviewed |
Collaborator
Author
|
Review round 1 — triage and outcome (answering the OpenCodeReview finding routed to this summary; no inline threads exist):
Verified: |
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
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.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Fourteen pages of the model store and model deployment domains sat flat in
docs/reference/— adirectory the conventions define as lookup tables with provenance — plus a runbook in
docs/operation/. They now sit in their own domain directories, the waydocs/kv-cache/alreadydoes:
docs/model-store/artifact.md,image-source.md,prefetch.md,node-store.md,peer-sync.md,views.md,operations.md(fromoperation/model-store.md)docs/model-deployment/deployment.md,prefill-decode.md,routing.md,metrics.md,status.md,shutdown.md,engine-versions.mdReferencesuffix, mirroringkv-cache/(backend.md↔"KV Cache Backend");
docs/reference/keeps the four true lookup pages.docs/README.md's page table regrouped into domain blocks; reading paths updated._ModelDeploymentDocsPath, the apicomment that generation copies into
generated.proto/ OpenAPI / applyconfiguration(regenerated), the docs skill's routing table, page map and conventions, the overview and e2e
skills, and every cross-link and link label.
specs/records stay untouched.kv-cache/split never got.Which issue(s) this PR links to:
NONE
Special notes for your reviewer:
Verified:
make lint docs,make lint,make lint agents-shell, andcheck-docs.sh(49 pages; links,anchors, headers, index labels).
TestModelDeploymentOwnedKeysDocsandRACE=false make test— full suite green.make generatereproduces the committed artifacts; the only code deltas are the test constantand one doc-path mention in an api comment.
specs/(frozen records,per the docs skill's own policy), including line-joined label phrases.
Not run: e2e — the change is docs plus those two inert code deltas.
make testwith the racedetector fails in
pkg/utils/certs/cache(Test_k8sCache_TamperedSecretIsLoggedAsKeyValuePairs,alitto/pondinvokeTask); it fails identically on cleanmain(5cfac77), so it predates thisbranch.
Does this PR introduce a user-facing change?