docs: fix minValues description text to match YAML example#8999
Open
docs: fix minValues description text to match YAML example#8999
Conversation
The description text for the minValues section incorrectly referred to instance-category values [c,m,r] as "instance families" when they are actually "instance categories". Also fixed "is required" to "are required" for grammatical correctness. Fixes kubernetes-sigs/karpenter#2548
moko-poi
force-pushed
the
fix/docs-min-values-text-mismatch
branch
from
c448564 to
23faea7
Compare
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.
Summary
instance-categoryvalues[c,m,r]as "instance families" — they are "instance categories"Fixes kubernetes-sigs/karpenter#2548
Details
The YAML example uses
karpenter.k8s.aws/instance-categorywith values["c", "m", "r"]andminValues: 2, but the description text said "2 unique instance families from [c,m,r]". This is incorrect —[c, m, r]are instance categories, not families. Instance families (e.g., "m5", "c5") are handled by the separatekarpenter.k8s.aws/instance-familyrequirement.Test plan
instance-category[c,m,r] minValues:2 → "2 unique instance categories"instance-familyminValues:5 → "5 unique instance families"instance-typeminValues:10 → "10 unique instance types"