docs: edits to customization guide #1436
Merged
Conversation
This file contains 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
✅ Deploy Preview for kubernetes-sigs-nfd ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
k8s-ci-robot
added
cncf-cla: yes
|
Requires #1437 for the verify-docs job to pass muster |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 2dd466727ea0bfc0851021e8843f96e06f0b55d9
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ArangoGutierrez, marquiz The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
marquiz
force-pushed
the
devel/docs-customization-guide
branch
from
d4ae422
to
882e1db
Compare
k8s-ci-robot
removed
the
lgtm
marquiz
force-pushed
the
devel/docs-customization-guide
branch
from
882e1db
to
3561be4
Compare
|
ping @ArangoGutierrez now the test results are green |
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: e47ab98b80e2e37c8c56db03bd4465e96f663c2b
|
"Feature rule format" is more appropriate as we now support extended resources and taints in addition to labels.
Small edit to how tainting is documented in the customization guide. First, make the heading shorter. Then, move the detailed example yaml and its description further down in the document to the section that describes the "taints" field - this is now similar how extended resources are documented.
Rename the sub-section headings of the "Fields" section (describing the fields of NodeFeatureRule) to match the actual field names (as in YAML).
marquiz
force-pushed
the
devel/docs-customization-guide
branch
from
3561be4
to
0a30cf9
Compare
k8s-ci-robot
removed
the
lgtm
|
Rebased |
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
LGTM label has been added. Git tree hash: 51b68d46f7086cef3403b62bbd77abf173b80929
|
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.
This PR comprises of a few changes to the customization guide, in an attempt to make it slightly more consistent and readable
"Feature rule format" is more appropriate as we now support extended
resources and taints in addition to labels.
Small edit to how tainting is documented in the customization guide.
First, make the heading shorter. Then, move the detailed example yaml
and its description further down in the document to the section that
describes the "taints" field - this is now similar how extended
resources are documented.
Rename the sub-section headings of the "Fields" section (describing the
fields of NodeFeatureRule) to match the actual field names (as in YAML).