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

📖 Add documentation for declarative plugin #2562

Merged
merged 1 commit into from
Mar 30, 2022

Conversation

mariuskimmina
Copy link
Contributor

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.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 26, 2022
@k8s-ci-robot
Copy link
Contributor

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 /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

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.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 26, 2022
Copy link
Member

@camilamacedo86 camilamacedo86 left a 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 ?

@mariuskimmina

This comment was marked as resolved.

@mariuskimmina

This comment was marked as resolved.

@camilamacedo86

This comment was marked as resolved.

Copy link
Member

@camilamacedo86 camilamacedo86 left a 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 🥇

@camilamacedo86
Copy link
Member

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 29, 2022
@mariuskimmina
Copy link
Contributor Author

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.

Copy link
Member

@camilamacedo86 camilamacedo86 left a 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/

Screenshot 2022-03-29 at 18 03 19

The only thing that is not OK is the note, see;

Screenshot 2022-03-29 at 18 03 45

By fixing that I think it is good enough for us to get merged.

Comment on lines 6 to 11
<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>
Copy link
Member

@camilamacedo86 camilamacedo86 Mar 29, 2022

Choose a reason for hiding this comment

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

Suggested change
<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 :-(

Copy link
Contributor Author

@mariuskimmina mariuskimmina Mar 30, 2022

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

@mariuskimmina
Copy link
Contributor Author

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 <aside> block, so I changed this section up a bit - going to squash the commits again

Copy link
Member

@camilamacedo86 camilamacedo86 left a 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

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

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 30, 2022
@k8s-ci-robot k8s-ci-robot merged commit 6d59caf into kubernetes-sigs:master Mar 30, 2022
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. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants