-
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
Docs cleanup #1279
Comments
/good-first-issue |
@DirectXMan12: Please ensure the request meets the requirements listed here. If this request no longer meets these requirements, the label can be removed 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. |
Hi, I would like to work on it. |
@vaibhavk the first point should be pretty straightforward. Just follow the tutorial in a new project and doccument the differences in the file. Second point requires to verify that the testdata directory is not used for anything, and remove it. Third would require deep undestanding of the whole book creation process. |
Issues go stale after 90d of inactivity. If this issue is safe to close now please do so with Send feedback to sig-testing, kubernetes/test-infra and/or fejta. |
/lifecycle frozen |
Hi @Adirio, Following a few comments inline.
It shows a duplicate of #1251 so I think that can be removed from the scope of this issue. I mean the repo has another issue already to address the same. Also, the PR: https://github.com/kubernetes-sigs/kubebuilder/pull/1492/files probably address it.
The
I think the above would solve this one as well. WDYT? |
/assign @camilamacedo86 |
I listed them to remember we need to do it but I don't have enough knowledge of the inner workins of how the documentation is generated to really know if those files are being used somewhere or they aren't. You are saying that the testdata folder is being used for something so I would say we should keep it as long as we keep the migration guide (as you can see, that point was a question because I didn't know if it was being used or not). So, IMHO, we should remove that point from the list here and not remove the testdata folder until we remove the migration guide (if we ever do that). |
HI @Adirio, Sorry, may I could not clarify properly my thoughts. Following some comments Regards 1th Item
Regards 2th Item
PS.: IMO we should not migrate to the migration guide. We can create new ones when/if is required. It is a doc that should exist with its steps as history. We just do not need to keep Regards 3th Item
|
Yeah, I understood you correctly. What I mean is, if we have the migration guide (v1->v2) we keep the corresponding testdata folder, if we remove that guide we remove the folder. And yes, the first point is tracked in another Issue, this is just a list of things that were needed. Things can be removed or marked as done once they get resolved. |
added all detailed reasons why in POV is quite safe to delete the example of a V1 project that is just used in the migration guide from V1 to V2 in the PR: #1499 (comment) |
The book needs to be cleaned up.
/docs/book/src/migration/testdata
being used for anything? It should be removed if it isn't. Why should we have atestdata
folder that is the one used by the golden script inside one of the book chapters?/kind cleanup
The text was updated successfully, but these errors were encountered: