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.

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: Add Cobra docs generator and CI to ensure they remain up to date #2336

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

froblesmartin
Copy link

@froblesmartin froblesmartin commented Nov 24, 2024

As discussed at #2263, I think this could be integrated into the project.

If you agree with it, I can also help with #2064 by cleaning up duplicates in this PR or a new one, and referencing the new docs in the repo's main README.

Based in https://github.com/kubernetes/kubernetes/blob/master/cmd/gendocs/gen_kubectl_docs.go

@froblesmartin froblesmartin requested a review from a team as a code owner November 24, 2024 08:24
Copy link

google-cla bot commented Nov 24, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@froblesmartin froblesmartin changed the title Add Cobra docs generator and CI to ensure they remain up to date docs: Add Cobra docs generator and CI to ensure they remain up to date Nov 24, 2024
@froblesmartin froblesmartin force-pushed the docs/cobra-autogen branch 4 times, most recently from 9d9f17a to f2b55eb Compare November 24, 2024 08:49
@jackwotherspoon
Copy link
Collaborator

Thanks for this @froblesmartin! 👏 I will try and take a pass at reviewing the PR sometime this week 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants