📖 docs: Improve PROJECT file documentation

[ashutosh887]

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]

The committers listed above are authorized under a signed CLA.

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

[k8s-ci-robot]

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]

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.

[ashutosh887]

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

[jmrodri]

/ok-to-test

[Kavinjsir]

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]

@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]

@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 :)

[camilamacedo86]

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 ^

[ashutosh887]

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

[camilamacedo86]

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

• (to make links using alias) https://github.com/kubernetes-sigs/kubebuilder/pull/3287/files#r1141269463
• (to add alias at the bottom) https://github.com/kubernetes-sigs/kubebuilder/pull/3287/files#r1141269536

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

[ashutosh887]

@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]

@varshaprasad96 I've done the suggested changes

[varshaprasad96]

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

[Kavinjsir]

/lgtm

[camilamacedo86]

It has my lgtm after apply the suggestions

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[ashutosh887]

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

[camilamacedo86]

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]

Thanks @camilamacedo86 @varshaprasad96 @Kavinjsir ✨