From ed0fee91b1b29da9e4d4bb1100b00fdb13427ac0 Mon Sep 17 00:00:00 2001
From: Sirisha Gopigiri <sirishagopigiri@gmail.com>
Date: Wed, 5 May 2021 15:39:04 +0530
Subject: [PATCH] Generate user guide command links

This PS adds docs.airshipit.org link to long description
of the airshipctl root command output. The implementation
is done in-line with kubectl command.
https://github.com/kubernetes/kubectl/blob/master/pkg/cmd/cmd.go#L479

Closes: #281
Change-Id: Id65c53a72a840221c47677bacf9651f9430da276
---
 cmd/root.go                                                 | 6 ++++++
 .../rootCmd-with-default-subcommands.golden                 | 2 ++
 .../TestRootGoldenOutput/rootCmd-with-no-subcommands.golden | 2 ++
 .../specialized-rootCmd-with-bootstrap.golden               | 2 ++
 docs/source/cli/airshipctl.md                               | 3 +++
 5 files changed, 15 insertions(+)

diff --git a/cmd/root.go b/cmd/root.go
index 1d48b61e2..f04c2e40d 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -34,6 +34,11 @@ import (
 	"opendev.org/airship/airshipctl/pkg/log"
 )
 
+const longRoot = `A unified entrypoint to various airship components
+
+  Find more information at: https://docs.airshipit.org/airshipctl/
+`
+
 // RootOptions stores global flags values
 type RootOptions struct {
 	Debug             bool
@@ -54,6 +59,7 @@ func NewRootCommand(out io.Writer) (*cobra.Command, *RootOptions) {
 	rootCmd := &cobra.Command{
 		Use:           "airshipctl",
 		Short:         "A unified entrypoint to various airship components",
+		Long:          longRoot,
 		SilenceErrors: true,
 		SilenceUsage:  true,
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
diff --git a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden
index be661a787..fc68771cb 100644
--- a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden
+++ b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-default-subcommands.golden
@@ -1,5 +1,7 @@
 A unified entrypoint to various airship components
 
+  Find more information at: https://docs.airshipit.org/airshipctl/
+
 Usage:
   airshipctl [command]
 
diff --git a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden
index 48d5ef65a..6b941e9ec 100644
--- a/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden
+++ b/cmd/testdata/TestRootGoldenOutput/rootCmd-with-no-subcommands.golden
@@ -1,2 +1,4 @@
 A unified entrypoint to various airship components
 
+  Find more information at: https://docs.airshipit.org/airshipctl/
+
diff --git a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden
index d918aaf82..ed05f5364 100644
--- a/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden
+++ b/cmd/testdata/TestRootGoldenOutput/specialized-rootCmd-with-bootstrap.golden
@@ -1,5 +1,7 @@
 A unified entrypoint to various airship components
 
+  Find more information at: https://docs.airshipit.org/airshipctl/
+
 Usage:
   airshipctl [command]
 
diff --git a/docs/source/cli/airshipctl.md b/docs/source/cli/airshipctl.md
index d59b938b1..373b3ebd1 100644
--- a/docs/source/cli/airshipctl.md
+++ b/docs/source/cli/airshipctl.md
@@ -6,6 +6,9 @@ A unified entrypoint to various airship components
 
 A unified entrypoint to various airship components
 
+  Find more information at: https://docs.airshipit.org/airshipctl/
+
+
 ### Options
 
 ```