📖 Documentation for go/v2 and go/v3 plugin #2569

Ashwin901 · 2022-03-28T16:38:56Z

As mentioned in the issue #2542 I have added the documentation for the go/v2, go/v3 and also the available plugins page.
I have tried my best to follow all the checkpoints mentioned in the issue, but please let me know if any changes are required.

k8s-ci-robot · 2022-03-28T16:39:04Z

Welcome @Ashwin901!

It looks like this is your first PR to kubernetes-sigs/kubebuilder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kubebuilder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2022-03-28T16:39:05Z

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

docs/book/src/plugins/available-plugins.md

docs/book/src/plugins/go-v2-plugin.md

docs/book/src/plugins/go-v3-plugin.md

camilamacedo86

Great work 🥇

Just a few nits commented in the PR
Also, see that we need to squash the commits to get this one merged.
Could you please do that?
Also, feel free to update improve the text suggestions as you see that fits

camilamacedo86 · 2022-03-29T00:24:39Z

/ok-to-test

docs/book/src/plugins/available-plugins.md

camilamacedo86

Seems to be missing address the comments + rebase with master to solve the conflict with: #2562

Then we can get this one merged 🥇

Ashwin901 · 2022-03-30T13:48:18Z

Okay. I will do the changes and push it asap

Ashwin901 · 2022-03-30T20:02:51Z

Hey @camilamacedo86 I made the necessary changes and also rebased with master. Can you let me know what the issue is?

docs/book/src/plugins/declarative-v1.md

docs/book/src/SUMMARY.md

docs/book/src/plugins/go-v2-plugin.md

docs/book/src/plugins/go-v3-plugin.md

docs/book/src/plugins/go-v2-plugin.md

camilamacedo86

I did another review round.
I think are closer now to getting this good enough to be merged

Great work !

docs/book/src/plugins/go-v3-plugin.md

docs/book/src/plugins/go-v2-plugin.md

camilamacedo86

For me, just missing a few nits. Could you please address them so we are able to move forward?
Remove the bold and ensure that the notes has a title

Otherwise,
/approved

k8s-ci-robot · 2022-04-02T11:47:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Ashwin901, camilamacedo86

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:

~~OWNERS~~ [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Ashwin901 · 2022-04-02T16:03:33Z

@camilamacedo86 is everything fine now? Or are there any pending changes?

camilamacedo86 · 2022-04-02T16:35:23Z

Hi @Ashwin901,

@camilamacedo86 is everything fine now? Or are there any pending changes?

It shows all fine for me. But I pinged in the channel to see if we get help on the review.
IMO after we merge all docs we might have the need to shape a little to ensure the same standards and some details.

AlmogBaku · 2022-04-03T14:56:16Z

docs/book/src/plugins/available-plugins.md

+<aside class="note">
+
+<h1>But you can create your own plugins, see:</h1>


Remove the word "but"

Since you are contradicting a different paragraph, it's better just to write "You can create your own plugins, see"

Hun, the page speaks about available plugins. then, could we not consider this content a note, or observation? Because of this in POV it shows fit better in the

AlmogBaku · 2022-04-03T14:58:47Z

docs/book/src/plugins/available-plugins.md

+
+- [Creating your own plugins][create-plugins]. 
+- [Plugins Phase 2][plugins-phase-2] - will allow users to use these external options as helpers to perform the scaffolds with the tool.


This item should be outside to the aside

So the two items should be placed outside the aside section?

AlmogBaku · 2022-04-03T15:01:58Z

docs/book/src/plugins/available-plugins.md

+
+</aside>
+


missing a link to the v3

AlmogBaku · 2022-04-03T15:02:22Z

docs/book/src/plugins/available-plugins.md

+</aside>
+
+[create-plugins]: creating-plugins.md


this line should probably be inside of the aside?

Nops, the link alias should be at the bottom of the docs pages to make it easier we keep the maintained.
That is the standard.

AlmogBaku · 2022-04-03T15:02:26Z

docs/book/src/plugins/available-plugins.md

+
+[create-plugins]: creating-plugins.md
+[plugins-phase-2]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-2.md


this line should probably be inside of the aside?

AlmogBaku · 2022-04-03T15:06:14Z

docs/book/src/plugins/go-v3-plugin.md

@@ -0,0 +1,57 @@
+# go/v3
+
+Kubebuilder tool will scaffold the go/v3 plugin by default. This plugin is a composition of the plugins ` kustomize.common.kubebuilder.io/v1` and `base.go.kubebuilder.io/v3`. By using you can scaffold the default project which is a helper to construct sets of [controllers][controller-runtime]. 


"Kubebuilder tool will scaffold the go/v3 plugin by default." -> add a new paragraph after this line, and perhaps make it bold.
"By using ..." -> "Using the plugin, you can..."

AlmogBaku · 2022-04-03T15:08:51Z

docs/book/src/plugins/go-v2-plugin.md

@@ -0,0 +1,51 @@
+# go/v2 plugin
+
+The `go/v2` plugin has the purpose to scaffold Golang projects to help users to build projects with [controllers][controller-runtime] and keep the backwards compatibility with the default scaffold made using Kubebuilder CLI `2.x.z` releases.   


"...to scaffold Golang projects to help users..." -> "... to scaffold Golang projects by helping users..."

"...to scaffold..." -> "...of scaffolding..."

AlmogBaku · 2022-04-03T15:11:00Z

docs/book/src/plugins/go-v2-plugin.md

+
+</node>  
+
+## When should I use this plugin


add a question mark

AlmogBaku · 2022-04-03T15:13:23Z

Thank you for your contribution @Ashwin901 !
I suggest a few changes in the comments :)

camilamacedo86 · 2022-04-13T09:41:33Z

Hi @Ashwin901,

mainly all suggestions are addressed and it shows in a good shape to get merged.
We still need to add. in the questions, however, I think the others plugins docs have done so far also need it.

So, @AlmogBaku @Ashwin901

Let's get this merged to not lost the contribution and work on some improvements shapes required as follows. I hope that is fine and I hope that you can help with this follow up so we are able to organize and improve the whole content.

/lgtm

camilamacedo86 · 2022-04-13T09:41:45Z

/lgtm

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

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 28, 2022

k8s-ci-robot requested review from estroz and pwittrock March 28, 2022 16:39

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v2-plugin.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v2-plugin.md Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v2-plugin.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v2-plugin.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v2-plugin.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

docs/book/src/plugins/go-v3-plugin.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 28, 2022

View reviewed changes

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

camilamacedo86 reviewed Mar 30, 2022

View reviewed changes

docs/book/src/plugins/available-plugins.md Outdated Show resolved Hide resolved

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 30, 2022

camilamacedo86 requested changes Mar 30, 2022

View reviewed changes

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 30, 2022

camilamacedo86 reviewed Mar 30, 2022

View reviewed changes

docs/book/src/plugins/declarative-v1.md Outdated Show resolved Hide resolved

rashmigottipati reviewed Mar 30, 2022

View reviewed changes

docs/book/src/plugins/declarative-v1.md Outdated Show resolved Hide resolved

camilamacedo86 reviewed Mar 30, 2022

View reviewed changes

docs/book/src/SUMMARY.md Outdated Show resolved Hide resolved

Ashwin901 closed this Apr 1, 2022

Ashwin901 force-pushed the 2542-plugin-docs branch from 0b8ff9f to cacfd2d Compare April 1, 2022 19:17

Ashwin901 mentioned this pull request Apr 1, 2022

📖 add to the website the plugins versioning documentation #2588

Merged