Try adding header to generated CLI docs

kubernetes · Jul 15, 2017 · d797eb1 · d797eb1
1 parent d2e5ec2
commit d797eb1
Show file tree

Hide file tree

Showing 41 changed files with 90 additions and 1 deletion.
diff --git a/cmd/kops/gen_help_docs.go b/cmd/kops/gen_help_docs.go
@@ -21,6 +21,11 @@ import (
 	"github.com/spf13/cobra/doc"
 )
 
+const fileHeader = `
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
+
+`
+
 type GenHelpDocsCmd struct {
 	cobraCommand *cobra.Command
 	OutDir       string
@@ -55,5 +60,9 @@ func (c *GenHelpDocsCmd) Run() error {
 	for _, c := range rootCommand.cobraCommand.Commands() {
 		c.Flag("state").DefValue = ""
 	}
-	return doc.GenMarkdownTree(rootCommand.cobraCommand, c.OutDir)
+
+	linkHandler := func(link string) string { return link }
+	filePrepender := func(filname string) string { return fileHeader }
+
+	return doc.GenMarkdownTreeCustom(rootCommand.cobraCommand, c.OutDir, filePrepender, linkHandler)
 }
diff --git a/docs/cli/kops.md b/docs/cli/kops.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops
 
 kops is Kubernetes ops.

diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops completion
 
 Output shell completion code for the given shell (bash or zsh).

diff --git a/docs/cli/kops_create.md b/docs/cli/kops_create.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops create
 
 Create a resource by command line, filename or stdin.

diff --git a/docs/cli/kops_create_cluster.md b/docs/cli/kops_create_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops create cluster
 
 Create a Kubernetes cluster.

diff --git a/docs/cli/kops_create_instancegroup.md b/docs/cli/kops_create_instancegroup.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops create instancegroup
 
 Create an instancegroup.

diff --git a/docs/cli/kops_create_secret.md b/docs/cli/kops_create_secret.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops create secret
 
 Create a secret.

diff --git a/docs/cli/kops_create_secret_sshpublickey.md b/docs/cli/kops_create_secret_sshpublickey.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops create secret sshpublickey
 
 Create a ssh public key.

diff --git a/docs/cli/kops_delete.md b/docs/cli/kops_delete.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops delete
 
 Delete clusters,instancegroups, or secrets.

diff --git a/docs/cli/kops_delete_cluster.md b/docs/cli/kops_delete_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops delete cluster
 
 Delete a cluster.

diff --git a/docs/cli/kops_delete_instancegroup.md b/docs/cli/kops_delete_instancegroup.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops delete instancegroup
 
 Delete instancegroup

diff --git a/docs/cli/kops_delete_secret.md b/docs/cli/kops_delete_secret.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops delete secret
 
 Delete a secret

diff --git a/docs/cli/kops_describe.md b/docs/cli/kops_describe.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops describe
 
 Describe a resource.

diff --git a/docs/cli/kops_describe_secrets.md b/docs/cli/kops_describe_secrets.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops describe secrets
 
 Describe a cluster secret

diff --git a/docs/cli/kops_edit.md b/docs/cli/kops_edit.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops edit
 
 Edit clusters and other resources.

diff --git a/docs/cli/kops_edit_cluster.md b/docs/cli/kops_edit_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops edit cluster
 
 Edit cluster.

diff --git a/docs/cli/kops_edit_federation.md b/docs/cli/kops_edit_federation.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops edit federation
 
 Edit federation.

diff --git a/docs/cli/kops_edit_instancegroup.md b/docs/cli/kops_edit_instancegroup.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops edit instancegroup
 
 Edit instancegroup.

diff --git a/docs/cli/kops_export.md b/docs/cli/kops_export.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops export
 
 Export configuration.

diff --git a/docs/cli/kops_export_kubecfg.md b/docs/cli/kops_export_kubecfg.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops export kubecfg
 
 Export kubecfg.

diff --git a/docs/cli/kops_get.md b/docs/cli/kops_get.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops get
 
 Get one or many resources.

diff --git a/docs/cli/kops_get_clusters.md b/docs/cli/kops_get_clusters.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops get clusters
 
 Get one or many clusters.

diff --git a/docs/cli/kops_get_federations.md b/docs/cli/kops_get_federations.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops get federations
 
 Get federation.

diff --git a/docs/cli/kops_get_instancegroups.md b/docs/cli/kops_get_instancegroups.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops get instancegroups
 
 Get one or many instancegroups

diff --git a/docs/cli/kops_get_secrets.md b/docs/cli/kops_get_secrets.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops get secrets
 
 Get one or many secrets.

diff --git a/docs/cli/kops_import.md b/docs/cli/kops_import.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops import
 
 Import a cluster.

diff --git a/docs/cli/kops_import_cluster.md b/docs/cli/kops_import_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops import cluster
 
 Import a cluster.

diff --git a/docs/cli/kops_replace.md b/docs/cli/kops_replace.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops replace
 
 Replace cluster resources.

diff --git a/docs/cli/kops_rolling-update.md b/docs/cli/kops_rolling-update.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops rolling-update
 
 Rolling update a cluster.

diff --git a/docs/cli/kops_rolling-update_cluster.md b/docs/cli/kops_rolling-update_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops rolling-update cluster
 
 Rolling update a cluster.

diff --git a/docs/cli/kops_toolbox.md b/docs/cli/kops_toolbox.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops toolbox
 
 Misc infrequently used commands.

diff --git a/docs/cli/kops_toolbox_convert-imported.md b/docs/cli/kops_toolbox_convert-imported.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops toolbox convert-imported
 
 Convert an imported cluster into a kops cluster.

diff --git a/docs/cli/kops_toolbox_dump.md b/docs/cli/kops_toolbox_dump.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops toolbox dump
 
 Dump cluster information

diff --git a/docs/cli/kops_update.md b/docs/cli/kops_update.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops update
 
 Update a cluster.

diff --git a/docs/cli/kops_update_cluster.md b/docs/cli/kops_update_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops update cluster
 
 Update a cluster.

diff --git a/docs/cli/kops_update_federation.md b/docs/cli/kops_update_federation.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops update federation
 
 Update federation cluster resources.

diff --git a/docs/cli/kops_upgrade.md b/docs/cli/kops_upgrade.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops upgrade
 
 Upgrade a kubernetes cluster.

diff --git a/docs/cli/kops_upgrade_cluster.md b/docs/cli/kops_upgrade_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops upgrade cluster
 
 Upgrade a kubernetes cluster.

diff --git a/docs/cli/kops_validate.md b/docs/cli/kops_validate.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops validate
 
 Validate a kops cluster.

diff --git a/docs/cli/kops_validate_cluster.md b/docs/cli/kops_validate_cluster.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops validate cluster
 
 Validate a kops cluster.

diff --git a/docs/cli/kops_version.md b/docs/cli/kops_version.md
@@ -1,3 +1,5 @@
+
+<!--- This file is automatically generated by make gen-cli-docs; changes should be made in the go CLI command code -->
 ## kops version
 
 Print the kops version information.