-
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
📖 Add documentation for declarative plugin #2562
📖 Add documentation for declarative plugin #2562
Conversation
Hi @mariuskimmina. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. 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. |
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.
I loved it 🥇
Terrific work 🚀
I added a few suggetions. Also, could you please squash all commits for we are able to get it merged ?
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
d0a66ca
to
511654a
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.
I did a last round of reviews. Could you please check it out and let me know wdyt?
Also, after address, the comments could you please squash the commits for we get this one merged?
By latest, that is a terrific work 🥇
/ok-to-test |
511654a
to
c466d10
Compare
I have squashed the commits into one and have adjusted the docs according to your last review - I have slightly adjusted some of your suggestions. |
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.
We can test the final result by clicking on the preview test: https://deploy-preview-2562--kubebuilder.netlify.app/
The only thing that is not OK is the note, see;
By fixing that I think it is good enough for us to get merged.
<aside class="note"> | ||
You can check samples using this plugin by looking at the `project-<go plugin version>-addon` samples under the [testdata][testdata] directory on the root directory of the Kubebuilder project. | ||
</aside> |
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.
<aside class="note"> | |
You can check samples using this plugin by looking at the `project-<go plugin version>-addon` samples under the [testdata][testdata] directory on the root directory of the Kubebuilder project. | |
</aside> | |
<aside class="note"> | |
<h1>Examples</h1> | |
You can check samples using this plugin by looking at the `project-<go plugin version>-addon` samples under the [testdata](https://github.com/kubernetes-sigs/kubebuilder/tree/master/testdata/) directory on the root directory of the Kubebuilder project. | |
</aside> |
Seems that the note does not work with the link alias :-(
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.
That is strange, because it works in plugins.md
- there an alias is also used inside the <aside>
tag
Looking at https://deploy-preview-2562--kubebuilder.netlify.app/ the link alias works now, the problem was the usage of the code block inside the |
61169b4
to
e5ac4f0
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.
Great work 🥇
That shows good enough for us to get it merged!
However, we can always do follow-ups and etc if we see that hoes for impairments.
So,
/lgtm
/approved
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, mariuskimmina 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 |
As discussed in #2542 I'm proposing a documentation for the
declarative
plugin here.This is just a first draft an I'm open for suggestions as to what can be improved.
Also feel free to point out if anything seems incorrect.
I think the subcommands section should contain more detail but I'm unsure as to what else to say there.