Skip to content

📖 docs: Improve PROJECT file documentation #3287

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 21 commits into from
Mar 19, 2023
Merged

📖 docs: Improve PROJECT file documentation #3287

merged 21 commits into from
Mar 19, 2023

Conversation

ashutosh887
Copy link
Contributor

Change Description:

I've updated the Overview section in the Kubebuilder Docs project-config

Motivation:

It had to be updated because the PROJECT file was introduced since Kubebuilder release 3.0.0, where the Plugins design was introduced but the overview section was not clear.

Fixes: #3088

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 12, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: ashutosh887 / name: Ashutosh Jha (46f08d8)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 12, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @ashutosh887!

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 size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Mar 12, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @ashutosh887. 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 12, 2023
@ashutosh887
Copy link
Contributor Author

@camilamacedo86 Let me know if any further improvements are needed in the PR
I'm Open to suggestions

@jmrodri
Copy link
Contributor

jmrodri commented Mar 12, 2023

/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 12, 2023
Kavinjsir
Kavinjsir reviewed Mar 13, 2023
View reviewed changes
Copy link
Contributor

@Kavinjsir Kavinjsir left a comment

Choose a reason for hiding this comment

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

What about we merge this newly created paragraph with the above sentence? For instance:

The PROJECT file was introduced since Kubebuilder releases 3.0.0, where the Plugins design was implemented. When scaffolding an operator, the CLI will generate a PROJECT file in the project's root directory. It tracks all data used to perform scaffolds and stores information on resources and plugins in use. These data enable plugins to make more informed decisions during scaffolding, improving their usefulness.

@ashutosh887
Copy link
Contributor Author

@Kavinjsir It looks good to me
Would you like me to replace the complete overview section with the above Content you've shared + some links embedded into it (as I'd done)

@Kavinjsir
Copy link
Contributor

@Kavinjsir It looks good to me Would you like me to replace the complete overview section with the above Content you've shared + some links embedded into it (as I'd done)

Sounds good to me :)

@ashutosh887 ashutosh887 requested review from Kavinjsir and removed request for camilamacedo86 and jmrodri March 13, 2023 05:12
camilamacedo86
camilamacedo86 reviewed Mar 13, 2023
View reviewed changes
docs/book/src/reference/project-config.md

The PROJECT file was introduced since Kubebuilder [release 3.0.0](https://github.com/kubernetes-sigs/kubebuilder/releases/tag/v3.0.0), where the Plugins design was implemented. When scaffolding an operator, the CLI will generate a PROJECT file in the project's root directory. It tracks all data used to perform scaffolds and stores information on resources and plugins in use. These data enable plugins to make more informed decisions during scaffolding, improving their usefulness ([see an example PROJECT file](https://github.com/kubernetes-sigs/kubebuilder/blob/6f1f8c43cfbf260c971037ff039cca86a0980006/testdata/project-v3-with-deploy-image/PROJECT#L2-L21)).

## Versioning
Copy link
Member

Choose a reason for hiding this comment

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

Could we ensure that we have here the info shared in the following email of this thread? https://groups.google.com/g/kubebuilder/c/5c4_Xc3Fjx0/m/TERhvqaPBQAJ

Also, could we use alias for the docs so that is easier for we keep it maintained?

The links should be at the bottom of the doc

I added some suggestions above ^

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sure I've done the changes as you've recommended

Copy link
Member

Choose a reason for hiding this comment

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

Hi @ashutosh887 it still not done, see the following suggestions:

Could you please ensure that all links are with alias and the alias are at the bottom?

camilamacedo86
camilamacedo86 reviewed Mar 13, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 13, 2023
View reviewed changes
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 13, 2023
@ashutosh887
Copy link
Contributor Author

@camilamacedo86 I've tried to resolve the changes using GitHub suggestion as per your advise.
Please review it and let me know if any more changes are needed

@ashutosh887
Copy link
Contributor Author

@varshaprasad96 I've done the suggested changes

@varshaprasad96
Copy link
Member

@camilamacedo86 @Kavinjsir @everettraven Can we have another lgtm?

@Kavinjsir
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 17, 2023
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed changes
camilamacedo86
camilamacedo86 reviewed Mar 19, 2023
View reviewed 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.

It has my lgtm after apply the suggestions

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

New changes are detected. LGTM label has been removed.

@ashutosh887
Copy link
Contributor Author

Thanks @camilamacedo86
I've done the changes as per your Suggestion

@camilamacedo86 camilamacedo86 added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Mar 19, 2023
@camilamacedo86 camilamacedo86 merged commit 22fb666 into kubernetes-sigs:book-v3 Mar 19, 2023
@camilamacedo86
Copy link
Member

I moved forward with this one because I understand that has the lgtm from @varshaprasad96 and @Kavinjsir as well.
However, if something still requires changes in your POV @varshaprasad96 @Kavinjsir please let use know so we can address them in a follow-up.

@ashutosh887
Copy link
Contributor Author

Thanks @camilamacedo86 @varshaprasad96 @Kavinjsir ✨

camilamacedo86 pushed a commit to camilamacedo86/kubebuilder that referenced this pull request Apr 18, 2023
@ashutosh887 @camilamacedo86
📖 docs: Improve PROJECT file documentation (kubernetes-sigs#3287)
ecf5843
@camilamacedo86 camilamacedo86 mentioned this pull request Apr 21, 2023
Merged
@ashutosh887 ashutosh887 mentioned this pull request Jun 13, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@camilamacedo86 camilamacedo86 camilamacedo86 left review comments

@varshaprasad96 varshaprasad96 varshaprasad96 requested changes

+1 more reviewer

@Kavinjsir Kavinjsir Kavinjsir requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Kavinjsir Kavinjsir

@varshaprasad96 varshaprasad96

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. 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. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ashutosh887 @k8s-ci-robot @jmrodri @Kavinjsir @varshaprasad96 @camilamacedo86