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.

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

Improve PROJECT file documentation #3088

Closed
danaradg opened this issue Nov 20, 2022 · 19 comments
Closed

Improve PROJECT file documentation #3088

danaradg opened this issue Nov 20, 2022 · 19 comments
Assignees
@ashutosh887 @Sajiyah-Salat
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@danaradg
Copy link

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
@danaradg danaradg added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 20, 2022
@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 20, 2022
@varshaprasad96
Copy link
Member

varshaprasad96 commented Nov 21, 2022 •
edited

@danaradg Thanks for raising the issue. Would you be open to submitting a PR to fix this issue?

@danaradg
Copy link
Author

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.

@camilamacedo86 camilamacedo86 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Dec 1, 2022
@camilamacedo86 camilamacedo86 mentioned this issue Dec 31, 2022
Merged
@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Dec 31, 2022
@Sajiyah-Salat
Copy link
Contributor

Sajiyah-Salat commented Feb 25, 2023 •
edited

I have gone through the merged pr and google group conversation. is @danaradg working on this issue?

@danaradg
Copy link
Author

Honestly, haven't gotten around to it. If you want to take over, feel free.

@Sajiyah-Salat
Copy link
Contributor

Great. Thank you.
/assign

@ashutosh887
Copy link
Contributor

Please let me work on this issue @camilamacedo86 @varshaprasad96

@ashutosh887
Copy link
Contributor

/assign

@Sajiyah-Salat
Copy link
Contributor

Hello @camilamacedo86 do you think this issue is still valid. I am ready to work on this.

@camilamacedo86
Copy link
Member

HI @Sajiyah-Salat,

Yes, this issue still valid. We need to improve the documentation with what was shared in the email thread.

@Sajiyah-Salat
Copy link
Contributor

Sure. I will work on that shortly.

@Sajiyah-Salat
Copy link
Contributor

can you please guide me to the file where you would like to seethe proejct information.

@varshaprasad96
Copy link
Member

@Sajiyah-Salat you could add more details on what PROJECT config file is in here: https://book.kubebuilder.io/reference/project-config.html

@Sajiyah-Salat
Copy link
Contributor

Thank you I will do that shortly.

@ashutosh887 ashutosh887 mentioned this issue Mar 12, 2023
Merged
@Sajiyah-Salat
Copy link
Contributor

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

@ashutosh887
Copy link
Contributor

Yes the PR is merged as well @Sajiyah-Salat @camilamacedo86

@Sajiyah-Salat
Copy link
Contributor

I know that.

@ashutosh887
Copy link
Contributor

Let's close this then 😄🙌🏻

@Sajiyah-Salat
Copy link
Contributor

/close

@k8s-ci-robot
Copy link
Contributor

@Sajiyah-Salat: Closing this issue.

In response to this:

/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ashutosh887 ashutosh887

@Sajiyah-Salat Sajiyah-Salat

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/documentation Categorizes issue or PR as related to documentation. kind/feature Categorizes issue or PR as related to a new feature. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@camilamacedo86 @k8s-ci-robot @varshaprasad96 @ashutosh887 @danaradg @Sajiyah-Salat