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

Auto-generated documentation for basic buildin kyma-cli commands #2352

Open
pPrecel opened this issue Feb 21, 2025 · 0 comments
Open

Auto-generated documentation for basic buildin kyma-cli commands #2352

pPrecel opened this issue Feb 21, 2025 · 0 comments
Assignees
@pPrecel
Labels
area/cli Related to all activities around CLI

Comments

@pPrecel
Copy link
Contributor

pPrecel commented Feb 21, 2025 •
edited
Loading

Description

Implement auto-generating documentation mechanism (like it was for the kyma@v2). Documentation should be generated using cobra library and put under the docs/user/gen-docs folder.

Do not implement validation mechanism. Script/program should be run manually using Makefile target (e.g. make docs).

Reasons

User should be able to read about the kyma cli possibilities on the kyma-project.io webpage
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pPrecel pPrecel

Labels
area/cli Related to all activities around CLI
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pPrecel