Skip to content

docs: replace engine.version with engine.image in examples - #774

Merged
thxCode merged 1 commit into
mainfrom
docs/engine-image-in-examples
Oct 19, 2026
Merged

thxCode merged 1 commit into
mainfrom
docs/engine-image-in-examples

Conversation

@thxCode

@thxCode thxCode commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

What type of PR is this?

/kind documentation
/area worker

What this PR does / why we need it:

ModelDeploymentEngine no longer has a version field. It carries name and a required image, and engine-versions.md already says so. The README and five walkthroughs still showed engine.version: "0.29.0", so copying them gave an invalid manifest.

  • Replace engine.version: "0.29.0" with engine.image: gpustack/runner:cuda13.0-vllm0.29.0 in README.md and six places across five pages under docs/walkthroughs/.
  • The tag is the one the rest of the docs already use.

Which issue(s) this PR links to:

NONE

Special notes for your reviewer:

  • Documentation only. make lint docs passes.
  • The walkthroughs were not re-run. If one records a live run, its image may differ from what ran.

Does this PR introduce a user-facing change?

NONE

ModelDeploymentEngine has no version field; the examples now name a gpustack/runner image.

Signed-off-by: thxCode <thxcode0824@gmail.com>
@thxCode
thxCode force-pushed the docs/engine-image-in-examples branch from 342f0d3 to fcbd514 Compare October 19, 2026 12:40
@thxCode
thxCode merged commit 79c912a into main Oct 19, 2026
3 checks passed
@thxCode
thxCode deleted the docs/engine-image-in-examples branch October 19, 2026 12:41
@gpustack-code-review

gpustack-code-review Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

🔍 OpenCodeReview found 1 issue(s) in this PR.

  • ✅ Successfully posted inline: 0 comment(s)
  • 📋 Routed to summary by policy: 1 comment(s)

documentation · low

📄 docs/walkthroughs/kv-cache/shared-cache.md (L148-L148)

⚠️ GitHub could not post this as an inline comment: Routed to summary (severity low · category documentation)

The replacement makes the trailing comment drift out of alignment (and "on the same store line" is hard to parse). Since the manifest line got longer, consider re-aligning or rewording the comment, e.g. image: gpustack/runner:cuda13.0-vllm0.29.0 # same image line as Step 1's default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant