馃尡 ClusterClass: add documentation fields for patches and variables #5825
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
k8s-ci-robot
added
cncf-cla: yes
sbueringer
commented
Dec 8, 2021
| @@ -261,6 +267,9 @@ type ClusterClassPatch struct { | |||
| // Name of the patch. | |||
| Name string `json:"name"` | |||
|
|
|||
| // Description is a human-readable description of this patch. | |||
| Description string `json:"description,omitempty"` | |||
There was a problem hiding this comment.
I've only added it top-level for now. I'm not sure if we really need it on PatchDefinition and JSONPatch
|
/assign @fabriziopandini @vincepri |
Signed-off-by: Stefan B眉ringer buringerst@vmware.com
sbueringer
force-pushed
the
pr-add-clusterclass-doc-fields
branch
from
d9071cf
to
2212968
Compare
|
/retest |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri 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 |
k8s-ci-robot
added
the
approved
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.
Signed-off-by: Stefan B眉ringer buringerst@vmware.com
What this PR does / why we need it:
Adds documentation fields which will make it easier for ClusterClass authors to document ClusterClasses.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #5649