-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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
Improve PROJECT file documentation #3088
Comments
@danaradg Thanks for raising the issue. Would you be open to submitting a PR to fix this issue? |
I would love to contribute, but will probably need some time to ramp up and better understand the kubebuilder arch and plugins in general. If you don't mind waiting, I don't mind putting the effort. Would also love reading material recommendations. |
I have gone through the merged pr and google group conversation. is @danaradg working on this issue? |
Honestly, haven't gotten around to it. If you want to take over, feel free. |
Great. Thank you. |
Please let me work on this issue @camilamacedo86 @varshaprasad96 |
/assign |
Hello @camilamacedo86 do you think this issue is still valid. I am ready to work on this. |
HI @Sajiyah-Salat, Yes, this issue still valid. We need to improve the documentation with what was shared in the email thread. |
Sure. I will work on that shortly. |
can you please guide me to the file where you would like to seethe proejct information. |
@Sajiyah-Salat you could add more details on what PROJECT config file is in here: https://book.kubebuilder.io/reference/project-config.html |
Thank you I will do that shortly. |
Hello @ashutosh887 you have worked well on this pr. congrats on this. I think the work is completed now. Should we close this pr? wdyt? @camilamacedo86 |
Yes the PR is merged as well @Sajiyah-Salat @camilamacedo86 |
I know that. |
Let's close this then 😄🙌🏻 |
/close |
@Sajiyah-Salat: Closing this issue. In response to this:
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. |
What do you want to happen?
The kubebuilder book has a page for the
PROJECT
file that documents its structure, but doesn't provide an overview of its purpose and effect.Following this discussion it was suggested to incorporate the answer into the documentation.
Extra Labels
/kind documentation
The text was updated successfully, but these errors were encountered: