From ae975a818d98d3f2a9c195fb2d27644e268566af Mon Sep 17 00:00:00 2001 From: Martin Jirku Date: Wed, 17 Jan 2024 21:42:48 +0100 Subject: [PATCH 1/3] docs(cli): introduce examples in the kompose command Signed-off-by: Martin Jirku --- cmd/convert.go | 3 +++ cmd/root.go | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/cmd/convert.go b/cmd/convert.go index f9d6d867..ebe34ca3 100644 --- a/cmd/convert.go +++ b/cmd/convert.go @@ -79,6 +79,9 @@ var ( var convertCmd = &cobra.Command{ Use: "convert", Short: "Convert a Docker Compose file", + Example: ` kompose --file docker-voting.yml convert + kompose -f docker-compose.yml -f docker-guestbook.yml convert + kompose --provider openshift --file docker-voting.yml convert`, PreRun: func(cmd *cobra.Command, args []string) { // Check that build-config wasn't passed in with --provider=kubernetes diff --git a/cmd/root.go b/cmd/root.go index 68c0a9f6..18d0b259 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -53,6 +53,10 @@ var RootCmd = &cobra.Command{ Use: "kompose", Short: "A tool helping Docker Compose users move to Kubernetes", Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, + Example: ` kompose --file docker-voting.yml convert + kompose -f docker-compose.yml -f docker-guestbook.yml convert + kompose --provider openshift --file docker-voting.yml convert + kompose completion bash`, SilenceErrors: true, // PersistentPreRun will be "inherited" by all children and ran before *every* command unless // the child has overridden the functionality. This functionality was implemented to check / modify From 6ba1ff77de8732a77d05adf8b5ebfbc6d1916e5a Mon Sep 17 00:00:00 2001 From: Martin Jirku Date: Thu, 18 Jan 2024 21:52:35 +0100 Subject: [PATCH 2/3] docs(cli): remove docker name from cli Examples Signed-off-by: Martin Jirku --- cmd/convert.go | 6 +++--- cmd/root.go | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/cmd/convert.go b/cmd/convert.go index ebe34ca3..002004e1 100644 --- a/cmd/convert.go +++ b/cmd/convert.go @@ -79,9 +79,9 @@ var ( var convertCmd = &cobra.Command{ Use: "convert", Short: "Convert a Docker Compose file", - Example: ` kompose --file docker-voting.yml convert - kompose -f docker-compose.yml -f docker-guestbook.yml convert - kompose --provider openshift --file docker-voting.yml convert`, + Example: ` kompose --file compose.yaml convert + kompose -f first.yaml -f second.yaml convert + kompose --provider openshift --file compose.yaml convert`, PreRun: func(cmd *cobra.Command, args []string) { // Check that build-config wasn't passed in with --provider=kubernetes diff --git a/cmd/root.go b/cmd/root.go index 18d0b259..d5f9cb54 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -53,9 +53,9 @@ var RootCmd = &cobra.Command{ Use: "kompose", Short: "A tool helping Docker Compose users move to Kubernetes", Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, - Example: ` kompose --file docker-voting.yml convert - kompose -f docker-compose.yml -f docker-guestbook.yml convert - kompose --provider openshift --file docker-voting.yml convert + Example: ` kompose --file compose.yaml convert + kompose -f first.yaml -f second.yaml convert + kompose --provider openshift --file compose.yaml convert kompose completion bash`, SilenceErrors: true, // PersistentPreRun will be "inherited" by all children and ran before *every* command unless From e5e2fe2528a839d58842c0903735e9b7ccdad58b Mon Sep 17 00:00:00 2001 From: Martin Jirku Date: Thu, 18 Jan 2024 22:39:36 +0100 Subject: [PATCH 3/3] chore: format by gofmt Signed-off-by: Martin Jirku --- cmd/root.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/root.go b/cmd/root.go index d5f9cb54..bebdf803 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -50,9 +50,9 @@ var ( // RootCmd root level flags and commands var RootCmd = &cobra.Command{ - Use: "kompose", - Short: "A tool helping Docker Compose users move to Kubernetes", - Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, + Use: "kompose", + Short: "A tool helping Docker Compose users move to Kubernetes", + Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`, Example: ` kompose --file compose.yaml convert kompose -f first.yaml -f second.yaml convert kompose --provider openshift --file compose.yaml convert