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

feature: CLI doc update #3222

Open
1 task
mjudeikis opened this issue Dec 18, 2024 · 2 comments · May be fixed by #3224
Open
1 task

feature: CLI doc update #3222

mjudeikis opened this issue Dec 18, 2024 · 2 comments · May be fixed by #3224
Assignees
@jmcshane
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.

Comments

@mjudeikis
Copy link
Contributor

Feature Description

Currently, we have 3 CLI modules, but only 1 is wired into documentation generation:
image
Screenshot 2024-12-18 at 18 08 52

While other modules are kinda reprinted in this as they are added in, this is bit confusing.

Proposed Solution

We should extend rest of cli modules to generate docs same way we do for kubectl-kcp one and so extend the docs.

Alternative Solutions

No response

Want to contribute?

  • I would like to work on this issue.

Additional Context

No response
@mjudeikis mjudeikis added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 18, 2024
@kcp-ci-bot kcp-ci-bot added this to kcp Dec 18, 2024
@github-project-automation github-project-automation bot moved this to New in kcp Dec 18, 2024
@mjudeikis mjudeikis added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Dec 18, 2024
@jmcshane jmcshane linked a pull request Dec 19, 2024 that will close this issue
Open
@mjudeikis mjudeikis moved this from New to Backlog in kcp Dec 19, 2024
@jmcshane
Copy link

I'm taking this

@mjudeikis mjudeikis moved this from Backlog to In Progress in kcp Dec 19, 2024
@mjudeikis
Copy link
Contributor Author

/assign jmcshane

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

@jmcshane jmcshane

Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. kind/feature Categorizes issue or PR as related to a new feature.
Projects
kcp
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📖 Create CLI docs for workspace and create workspace cli jmcshane/kcp
2 participants
@mjudeikis @jmcshane