docs(profiles): promote image variants to its own section, de-duplicate gpu-instance - #250
Open
tylerpotts wants to merge 1 commit into
Open
tylerpotts wants to merge 1 commit into
tylerpotts wants to merge 1 commit into
Conversation
…te gpu-instance Review feedback on #237: server-profiles.md described gpu-instance twice and the reader hit the wrong one first. The gating example was a full GPU profile with no image-variant, so copying it put the CPU image on a GPU node, the exact failure #230 is about. - Pull the image-variant discussion out of "GPU profiles" into a top-level "Image variants" section placed right after "Adding a profile", before "Image choices within a profile", so readers see the key before they see profile_options.image (which defeats the injection). - State plainly that image-variant: gpu is the expected way to define a GPU profile; the GPU profiles section now points there and only covers scheduling. - Turn the gating example into a non-GPU profile so it reads as a gating example rather than a second GPU recipe, with a pointer to the real one. - Warn in "Image choices" not to combine profile_options.image with image-variant. - Point the values-reference image-variants row at the new anchor.
tylerpotts
force-pushed
the
docs/image-variants-section
branch
from
September 14, 2026 14:28
7f74315 to
b94a455
Compare
Contributor
|
Docs preview for |
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
2 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.
Follow-up to #237, addressing the docs suggestion in the approving review there.
Problem
server-profiles.mddescribedgpu-instancetwice and the reader hit the wrong one first. The example under "Gating profiles by group" was a full GPU profile (same slug, same display name,nvidia.com/gpu: 1) with noimage-variant, and it came after "Image choices within a profile" had already shownprofile_options.image, the key that defeats the injection. Someone scrolling for "how do I get GPUs" would stop at the gating example, copy it, and land on a GPU node running the CPU image, which is exactly #230.Changes
## Image variantssection right after "Adding a profile" and before "Image choices within a profile". The content is the former "The GPU image, without hardcoding a SHA" subsection, moved up and reworded to say plainly thatimage-variant: gpuis the expected way to define a GPU profile. Cross-links to gating and scheduling.## GPU profilesstays where it was and now only covers tolerations and scheduling, with a one-line pointer up to Image variants for the image. The lone### Scheduling onto GPU nodessub-heading is flattened.large-instancegated to a group plus a user), so it reads as a gating example rather than a second GPU recipe. A sentence below it points GPU readers at the real recipe.profile_options.imageto animage-variantprofile.values-reference.md: theimage-variantsrow now links to#image-variantsinstead of#gpu-profiles.Docs only. No chart or spawner changes.