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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摉 doc: Fix multigroup migration guide for v4 #3403

Merged
merged 1 commit into from
May 26, 2023

Conversation

juanluisvaladas
Copy link
Contributor

Fixes #3401 .
This is necessary because the paths of the warning were incorrect.

I added two separate instructions for both v3 and v4 as there were a few more differences besides the path.

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

Welcome @juanluisvaladas!

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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 10, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @juanluisvaladas. 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/migration/multi-group.md Outdated Show resolved Hide resolved
docs/book/src/migration/multi-group.md Outdated Show resolved Hide resolved
docs/book/src/migration/multi-group.md Outdated Show resolved Hide resolved
@varshaprasad96
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 May 10, 2023
@juanluisvaladas
Copy link
Contributor Author

Thanks for the review!
There were a few trailing whitespaces so I removed those and then I did a manual merge and squash.

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.

Thank you a lot for your contribution. it is amazing, just a few nits.

Note that the steps are mainly the same. The diff is that go/v3 does not have the controllers dir under internal dir.

So, could we not explain it with go/v3 and create a note to let the users know if they are using go/v3, which is deprecated, the steps are mainly the same? However, beware that the layout from go/v3 to go/v4 and the controllers, in this case, are in the root dir and not under the internal directory.

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.

IHMO, we need to prioritize explaining all using go/v4 (current layout) and then add a note to allow users using go/v3 still know what they should do in their case.

@juanluisvaladas
Copy link
Contributor Author

juanluisvaladas commented May 11, 2023

So, could we not explain it with go/v3 and create a note to let the users know if they are using go/v3, which is deprecated, the steps are mainly the same? However, beware that the layout from go/v3 to go/v4 and the controllers, in this case, are in the root dir and not under the internal directory.

I don't think that's a good idea, when I was doing the migration I found the statements confusing (even if the path was right I still think it'd be difficult). I think it's better to have duplicate instructions as the other option makes instructions less clear.

I modified this to have go/v4 first and removed the white lines and if you don't find this convincing then I'll remove the Go/v3 section and add the note.

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.

Just a few nits. Otherwise, it has my /lgtm

@juanluisvaladas
Copy link
Contributor Author

Hi, all the issues are addressed, also squashed everything into one commit.

@juanluisvaladas juanluisvaladas force-pushed the fix-mg-docs branch 2 times, most recently from a1d2f28 to 9472b8d Compare May 16, 2023 14:36
@juanluisvaladas
Copy link
Contributor Author

Hi @camilamacedo86, I didn't know this stuff about the project layout go/v2, so I decided to do a couple more modifications.

I rewrote the two notes on top almost from scratch. Please pay extra attention to those two points.
I removed the instructions for go/v3 (which were for go/v2) entirely and just duplicated the step for the controllers.

The rest remains unaltered.

@juanluisvaladas
Copy link
Contributor Author

Hi, sorry for the delay.

I amended the commit, here's the diff before the amend for easier review:

git diff
diff --git a/docs/book/src/migration/multi-group.md b/docs/book/src/migration/multi-group.md
index c6b861bf..f3e318b1 100644
--- a/docs/book/src/migration/multi-group.md
+++ b/docs/book/src/migration/multi-group.md
@@ -19,7 +19,7 @@ You can verify the version by looking at the PROJECT file. The currently default
 recommended version is go/v4.
 
 The layout go/v3 is **deprecated**, if you are using go/v3 it is recommended that you migrate to
-go/v4, however this documentation is still valid. [(More Info)][migration-guide].
+go/v4, however this documentation is still valid. [Migration from go/v3 to go/v4][migration-guide].
 
 This document is incompatible with go/v2. The documentation for go/v2 is still available in
 the [legacy documentation](https://book-v2.book.kubebuilder.io/migration/multi-group.html).
@@ -121,3 +121,4 @@ single-group projects).
 
 [multi-group-issue]: https://github.com/kubernetes-sigs/kubebuilder/issues/923 "Kubebuilder Issue #923"
 [cronjob-tutorial]: /cronjob-tutorial/cronjob-tutorial.md "Tutorial: Building CronJob"

There are no further changes.

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 could just find some nits the rest shows fine for me.

@juanluisvaladas
Copy link
Contributor Author

juanluisvaladas commented May 24, 2023

I believe this time everything is addressed :)
All the suggestions were commited and the last comment was also taken care of.

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.

It shows greta for me

Thank you a lot for your contribution 馃

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 24, 2023
@camilamacedo86 camilamacedo86 added the tide/merge-method-rebase Denotes a PR that should be rebased by tide when it merges. label May 24, 2023
@camilamacedo86
Copy link
Member

/pull-kubebuilder-test

@camilamacedo86
Copy link
Member

Hi @juanluisvaladas,

Could you please rebase with master and squash the commits? So that we can get this one merged?

Co-authored-by: Varsha <varshaprasad96@gmail.com>
Co-authored-by: Camila Macedo <7708031+camilamacedo86@users.noreply.github.com>
Signed-off-by: Juan-Luis de Sousa-Valadas Casta帽o <jvaladas@mirantis.com>
@juanluisvaladas
Copy link
Contributor Author

@camilamacedo86 done

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.

/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

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

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 merged commit 7711b8f into kubernetes-sigs:master May 26, 2023
7 checks passed
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/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-rebase Denotes a PR that should be rebased by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Single group to multi-group guide has wrong paths for plugins go/v4
4 participants