From 4962191833f189f1732c3c67796c3bd2ea6fe377 Mon Sep 17 00:00:00 2001 From: Ara Pulido Date: Mon, 13 Nov 2017 12:22:33 +0100 Subject: [PATCH] Improved a bit the messages and help we are giving to the user. --- cmd/down.go | 6 +++--- cmd/root.go | 7 +++++-- cmd/up.go | 11 +++++++++-- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/cmd/down.go b/cmd/down.go index 5d6eb3e1abd..d923fec46cc 100644 --- a/cmd/down.go +++ b/cmd/down.go @@ -7,8 +7,8 @@ import ( var downCmd = &cobra.Command{ Use: "down FLAG", - Short: "uninstall KubeApps components", - Long: `uninstall KubeApps components`, + Short: "Uninstall KubeApps components.", + Long: `Uninstall KubeApps components.`, RunE: func(cmd *cobra.Command, args []string) error { c := kubecfg.DeleteCmd{ DefaultNamespace: "default", @@ -39,5 +39,5 @@ var downCmd = &cobra.Command{ func init() { RootCmd.AddCommand(downCmd) - downCmd.Flags().Int64("grace-period", -1, "Number of seconds given to resources to terminate gracefully. A negative value is ignored") + downCmd.Flags().Int64("grace-period", -1, "Number of seconds given to resources to terminate gracefully. A negative value is ignored.") } diff --git a/cmd/root.go b/cmd/root.go index ad1647d605a..d87702e1e4c 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -31,7 +31,10 @@ var ( // RootCmd is the root of cobra subcommand tree var RootCmd = &cobra.Command{ Use: "kubeapps", - Short: "Kubeapps Installer manages to install Kubeapps components to your cluster", + Short: "kubeapps installs the Kubeapps components into your cluster", + Long: `kubeapps installs the Kubeapps components into your cluster. + +Find more information at https://github.com/kubeapps/installer.`, PersistentPreRunE: func(cmd *cobra.Command, args []string) error { out := cmd.OutOrStderr() logrus.SetOutput(out) @@ -129,5 +132,5 @@ func getHome() (string, error) { return home, nil } - return "", errors.New("can't get home directory") + return "", errors.New("Can't get home directory") } diff --git a/cmd/up.go b/cmd/up.go index df21b245257..9d41e1ced58 100644 --- a/cmd/up.go +++ b/cmd/up.go @@ -14,8 +14,15 @@ const ( var upCmd = &cobra.Command{ Use: "up FLAG", - Short: "install KubeApps components", - Long: `install KubeApps components`, + Short: "Install KubeApps components.", + Long: `Install KubeApps components. + +List of components that kubeapps up installs: + +- Kubeless (https://github.com/kubeless/kubeless) +- Sealed-Secrets (https://github.com/bitnami/sealed-secrets) +- Helm/Tiller (https://github.com/kubernetes/helm) +- Kubeapps Dashboard (https://github.com/kubeapps/dashboard)`, RunE: func(cmd *cobra.Command, args []string) error { c := kubecfg.ApplyCmd{ DefaultNamespace: "default",