-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 plugins doc #2115
📖 plugins doc #2115
Conversation
dd2a758
to
aa7fed6
Compare
cb8882a
to
cbb8796
Compare
/test pull-kubebuilder-e2e-k8s-1-16-15 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added some suggestions - mostly word-smithing and link-fixing. Two general points:
- Would the "Project config" fit better in the "Reference" section since it applies to more than just plugins?
- There is a "CLI Plugins" section (5.12)... should that be moved to the new "Plugins" section?
@camilamacedo86 These plugin docs are really helpful - thanks for adding them. Something that would also be super-helpful is a more complete example of a plugin that does something trivial like modify the base image in the Dockerfile. It wasn't immediately apparent to me how to go about this from looking through the SDK source. If I can get something working, I'll be happy to help by adding something along these lines later on. |
b841eea
to
954f59d
Compare
Hi @lander2k2, I really like the idea of the small example. We can add a mini tutorial in this section as well. WDYT? Would you like to work on that as follow up of this one? |
@camilamacedo86 Yes, I would love to take a swing at that as a follow-up. I'll work on getting a functioning example together to base the tutorial on. I'll open an issue and PR when it's ready. |
/test pull-kubebuilder-e2e-k8s-1-17-11 |
9e3f61e
to
0750e07
Compare
0750e07
to
95df8ef
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple comments, other than that it looks good.
95df8ef
to
5dd31f9
Compare
/hold Only to give the chance to get more reviews before the merge. |
/test pull-kubebuilder-e2e-k8s-1-16-15 |
5dd31f9
to
46a9f4f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comments to improve the appearance of the rendered markdown. Looking good.
46a9f4f
to
a311ed7
Compare
a311ed7
to
7855372
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, djzager 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 |
lgtm |
@lander2k2: changing LGTM is restricted to collaborators In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
/lgtm |
/hold cancel As an initial doc for the plugins that seem great enough. Thank you for your time and collab @lander2k2, @estroz, @djzager |
Description
Add plugins docs and how to use them. See the preview: https://deploy-preview-2115--kubebuilder.netlify.app/plugins/plugins.html
Motivation
Closes: #2098
Blocked by
#2106