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

Improve --help pages #1717

Closed
cdrage opened this issue Oct 3, 2023 · 0 comments · Fixed by #1808
Closed

Improve --help pages #1717

cdrage opened this issue Oct 3, 2023 · 0 comments · Fixed by #1808
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@cdrage
Copy link
Member

cdrage commented Oct 3, 2023

What would you like to be added?

Improve the --help pages to include an example on how to actually use the command.

▶ kompose convert --help
Convert a Docker Compose file

Usage:
  kompose convert [flags]

Kubernetes Flags:
  -c, --chart                    Create a Helm chart for converted objects
      --controller               Set the output controller ("deployment"|"daemonSet"|"replicationController")
      --service-group-mode       Group multiple service to create single workload by "label"("kompose.service.group") or "volume"(shared volumes)
      --service-group-name       Using with --service-group-mode=volume to specific a final service name for the group

Why is this needed?

Better documentation.

Improve the kompose convert --help command as well as the kompose --help command.

@cdrage cdrage added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant