ansible-operator,helm-operator: improve executable help text (operato…

…r-framework#4187) Co-authored-by: Eric Stroczynski <estroczy@redhat.com> Signed-off-by: reinvantveer <rein.van.t.veer@geodan.nl>
reinvantveer · Feb 5, 2021 · 853dfa9 · 853dfa9
1 parent feb6a79
commit 853dfa9
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/changelog/fragments/ansible-helm-help-text.yaml b/changelog/fragments/ansible-helm-help-text.yaml
@@ -0,0 +1,5 @@
+entries:
+  - description: >
+      Improved `ansible-operator` and `helm-operator` help text
+    kind: change
+    breaking: false
diff --git a/cmd/ansible-operator/main.go b/cmd/ansible-operator/main.go
@@ -26,6 +26,11 @@ import (
 
 func main() {
 	root := cobra.Command{
+		Short: "Reconcile an Ansible operator project using ansible-runner",
+		Long: `This binary runs an Ansible operator that reconciles Kubernetes resources
+managed by the ansible-runner program. It can be run either directly or from an Ansible
+operator project's image entrypoint
+`,
 		Use: "ansible-operator",
 	}
 

diff --git a/cmd/helm-operator/main.go b/cmd/helm-operator/main.go
@@ -26,6 +26,11 @@ import (
 
 func main() {
 	root := cobra.Command{
+		Short: "Reconcile an Helm operator project using helm",
+		Long: `This binary runs a Helm operator that reconciles Kubernetes resources
+managed by the helm program. It can be run either directly or from a Helm operator
+project's image entrypoint
+`,
 		Use: "helm-operator",
 	}