Skip to content
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

Merged
merged 1 commit into from
Apr 12, 2021
Merged

Conversation

camilamacedo86
Copy link
Member

@camilamacedo86 camilamacedo86 commented Mar 27, 2021

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

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Mar 27, 2021
@camilamacedo86 camilamacedo86 force-pushed the doc-plugin branch 9 times, most recently from dd2a758 to aa7fed6 Compare March 27, 2021 15:17
@camilamacedo86 camilamacedo86 force-pushed the doc-plugin branch 4 times, most recently from cb8882a to cbb8796 Compare March 29, 2021 11:18
@camilamacedo86
Copy link
Member Author

/test pull-kubebuilder-e2e-k8s-1-16-15

Copy link

@lander2k2 lander2k2 left a 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:

  1. Would the "Project config" fit better in the "Reference" section since it applies to more than just plugins?
  2. There is a "CLI Plugins" section (5.12)... should that be moved to the new "Plugins" section?

docs/book/src/plugins/plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
@lander2k2
Copy link

@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.

@camilamacedo86 camilamacedo86 force-pushed the doc-plugin branch 2 times, most recently from b841eea to 954f59d Compare March 30, 2021 23:10
@camilamacedo86
Copy link
Member Author

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?

@lander2k2
Copy link

@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.

@camilamacedo86
Copy link
Member Author

/test pull-kubebuilder-e2e-k8s-1-17-11

@camilamacedo86 camilamacedo86 force-pushed the doc-plugin branch 2 times, most recently from 9e3f61e to 0750e07 Compare April 9, 2021 11:44
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 9, 2021
Copy link

@djzager djzager left a 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.

docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
docs/book/src/plugins/creating-plugins.md Outdated Show resolved Hide resolved
@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Apr 9, 2021

/hold

Only to give the chance to get more reviews before the merge.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 9, 2021
@camilamacedo86
Copy link
Member Author

/test pull-kubebuilder-e2e-k8s-1-16-15

Copy link

@djzager djzager left a 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.

docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Outdated Show resolved Hide resolved
docs/book/src/plugins/extending-cli.md Show resolved Hide resolved
Copy link

@djzager djzager left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 12, 2021
@k8s-ci-robot
Copy link
Contributor

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@lander2k2
Copy link

lander2k2 commented Apr 12, 2021

lgtm

@k8s-ci-robot
Copy link
Contributor

@lander2k2: changing LGTM is restricted to collaborators

In response to this:

/lgtm

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.

@estroz
Copy link
Contributor

estroz commented Apr 12, 2021

/lgtm

@camilamacedo86
Copy link
Member Author

camilamacedo86 commented Apr 12, 2021

/hold cancel

As an initial doc for the plugins that seem great enough.
I am looking for a great idea of the tutorial as follow up @lander2k2 please feel free to ping me to review that one. :-)

Thank you for your time and collab @lander2k2, @estroz, @djzager

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 12, 2021
@k8s-ci-robot k8s-ci-robot merged commit 6a23847 into kubernetes-sigs:master Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how people can create their own plugins
6 participants