diff --git a/cmd/kops/gen_help_docs.go b/cmd/kops/gen_help_docs.go index b4b9ec4ad6..64a8ba2c93 100644 --- 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 = ` + + +` + 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 index ca085ae213..4bd683cb32 100644 --- a/docs/cli/kops.md +++ b/docs/cli/kops.md @@ -1,3 +1,6 @@ + + + ## kops kops is Kubernetes ops. diff --git a/docs/cli/kops_completion.md b/docs/cli/kops_completion.md index 9a02c69ab3..6d6679a76a 100644 --- a/docs/cli/kops_completion.md +++ b/docs/cli/kops_completion.md @@ -1,3 +1,6 @@ + + + ## 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 index fc5ec67732..f694bb6f13 100644 --- a/docs/cli/kops_create.md +++ b/docs/cli/kops_create.md @@ -1,3 +1,6 @@ + + + ## 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 index 24a1998c1e..808a5b24f1 100644 --- a/docs/cli/kops_create_cluster.md +++ b/docs/cli/kops_create_cluster.md @@ -1,3 +1,6 @@ + + + ## kops create cluster Create a Kubernetes cluster. diff --git a/docs/cli/kops_create_instancegroup.md b/docs/cli/kops_create_instancegroup.md index 1f07bafa53..ac2a68e760 100644 --- a/docs/cli/kops_create_instancegroup.md +++ b/docs/cli/kops_create_instancegroup.md @@ -1,3 +1,6 @@ + + + ## kops create instancegroup Create an instancegroup. diff --git a/docs/cli/kops_create_secret.md b/docs/cli/kops_create_secret.md index 5e7c958fd9..27e7b55d57 100644 --- a/docs/cli/kops_create_secret.md +++ b/docs/cli/kops_create_secret.md @@ -1,3 +1,6 @@ + + + ## kops create secret Create a secret. diff --git a/docs/cli/kops_create_secret_sshpublickey.md b/docs/cli/kops_create_secret_sshpublickey.md index de94140883..1fa8e84015 100644 --- a/docs/cli/kops_create_secret_sshpublickey.md +++ b/docs/cli/kops_create_secret_sshpublickey.md @@ -1,3 +1,6 @@ + + + ## kops create secret sshpublickey Create a ssh public key. diff --git a/docs/cli/kops_delete.md b/docs/cli/kops_delete.md index 05487deae0..845d38fc5a 100644 --- a/docs/cli/kops_delete.md +++ b/docs/cli/kops_delete.md @@ -1,3 +1,6 @@ + + + ## kops delete Delete clusters,instancegroups, or secrets. diff --git a/docs/cli/kops_delete_cluster.md b/docs/cli/kops_delete_cluster.md index 669226d9c5..a5ac16fa3f 100644 --- a/docs/cli/kops_delete_cluster.md +++ b/docs/cli/kops_delete_cluster.md @@ -1,3 +1,6 @@ + + + ## kops delete cluster Delete a cluster. diff --git a/docs/cli/kops_delete_instancegroup.md b/docs/cli/kops_delete_instancegroup.md index b807759f41..ab26129d2a 100644 --- a/docs/cli/kops_delete_instancegroup.md +++ b/docs/cli/kops_delete_instancegroup.md @@ -1,3 +1,6 @@ + + + ## kops delete instancegroup Delete instancegroup diff --git a/docs/cli/kops_delete_secret.md b/docs/cli/kops_delete_secret.md index d4c50481cc..ff92d446c9 100644 --- a/docs/cli/kops_delete_secret.md +++ b/docs/cli/kops_delete_secret.md @@ -1,3 +1,6 @@ + + + ## kops delete secret Delete a secret diff --git a/docs/cli/kops_describe.md b/docs/cli/kops_describe.md index 28921a40fb..7fb6c82fc2 100644 --- a/docs/cli/kops_describe.md +++ b/docs/cli/kops_describe.md @@ -1,3 +1,6 @@ + + + ## kops describe Describe a resource. diff --git a/docs/cli/kops_describe_secrets.md b/docs/cli/kops_describe_secrets.md index d87152c0f8..7fa15ef78d 100644 --- a/docs/cli/kops_describe_secrets.md +++ b/docs/cli/kops_describe_secrets.md @@ -1,3 +1,6 @@ + + + ## kops describe secrets Describe a cluster secret diff --git a/docs/cli/kops_edit.md b/docs/cli/kops_edit.md index 1e38490a19..6251013a5e 100644 --- a/docs/cli/kops_edit.md +++ b/docs/cli/kops_edit.md @@ -1,3 +1,6 @@ + + + ## kops edit Edit clusters and other resources. diff --git a/docs/cli/kops_edit_cluster.md b/docs/cli/kops_edit_cluster.md index 40b5a50ac7..34b9858bd2 100644 --- a/docs/cli/kops_edit_cluster.md +++ b/docs/cli/kops_edit_cluster.md @@ -1,3 +1,6 @@ + + + ## kops edit cluster Edit cluster. diff --git a/docs/cli/kops_edit_federation.md b/docs/cli/kops_edit_federation.md index 47621559f1..c1f701c502 100644 --- a/docs/cli/kops_edit_federation.md +++ b/docs/cli/kops_edit_federation.md @@ -1,3 +1,6 @@ + + + ## kops edit federation Edit federation. diff --git a/docs/cli/kops_edit_instancegroup.md b/docs/cli/kops_edit_instancegroup.md index c5730cc9b4..f1740ddad5 100644 --- a/docs/cli/kops_edit_instancegroup.md +++ b/docs/cli/kops_edit_instancegroup.md @@ -1,3 +1,6 @@ + + + ## kops edit instancegroup Edit instancegroup. diff --git a/docs/cli/kops_export.md b/docs/cli/kops_export.md index aaebb1ebc5..1d860f1753 100644 --- a/docs/cli/kops_export.md +++ b/docs/cli/kops_export.md @@ -1,3 +1,6 @@ + + + ## kops export Export configuration. diff --git a/docs/cli/kops_export_kubecfg.md b/docs/cli/kops_export_kubecfg.md index e9da647419..7069572552 100644 --- a/docs/cli/kops_export_kubecfg.md +++ b/docs/cli/kops_export_kubecfg.md @@ -1,3 +1,6 @@ + + + ## kops export kubecfg Export kubecfg. diff --git a/docs/cli/kops_get.md b/docs/cli/kops_get.md index 26154b3d9d..324a808e20 100644 --- a/docs/cli/kops_get.md +++ b/docs/cli/kops_get.md @@ -1,3 +1,6 @@ + + + ## kops get Get one or many resources. diff --git a/docs/cli/kops_get_clusters.md b/docs/cli/kops_get_clusters.md index fde4e9abb9..b132debfa9 100644 --- a/docs/cli/kops_get_clusters.md +++ b/docs/cli/kops_get_clusters.md @@ -1,3 +1,6 @@ + + + ## kops get clusters Get one or many clusters. diff --git a/docs/cli/kops_get_federations.md b/docs/cli/kops_get_federations.md index a94656e332..a27fc8a34e 100644 --- a/docs/cli/kops_get_federations.md +++ b/docs/cli/kops_get_federations.md @@ -1,3 +1,6 @@ + + + ## kops get federations Get federation. diff --git a/docs/cli/kops_get_instancegroups.md b/docs/cli/kops_get_instancegroups.md index f402372fda..a86cf0bc48 100644 --- a/docs/cli/kops_get_instancegroups.md +++ b/docs/cli/kops_get_instancegroups.md @@ -1,3 +1,6 @@ + + + ## kops get instancegroups Get one or many instancegroups diff --git a/docs/cli/kops_get_secrets.md b/docs/cli/kops_get_secrets.md index 3fca47205b..7579502827 100644 --- a/docs/cli/kops_get_secrets.md +++ b/docs/cli/kops_get_secrets.md @@ -1,3 +1,6 @@ + + + ## kops get secrets Get one or many secrets. diff --git a/docs/cli/kops_import.md b/docs/cli/kops_import.md index 99075e9de1..41a02a8385 100644 --- a/docs/cli/kops_import.md +++ b/docs/cli/kops_import.md @@ -1,3 +1,6 @@ + + + ## kops import Import a cluster. diff --git a/docs/cli/kops_import_cluster.md b/docs/cli/kops_import_cluster.md index 7cc504f124..1d607d75a4 100644 --- a/docs/cli/kops_import_cluster.md +++ b/docs/cli/kops_import_cluster.md @@ -1,3 +1,6 @@ + + + ## kops import cluster Import a cluster. diff --git a/docs/cli/kops_replace.md b/docs/cli/kops_replace.md index 1f9f1ca6d4..cd9e71a6f5 100644 --- a/docs/cli/kops_replace.md +++ b/docs/cli/kops_replace.md @@ -1,3 +1,6 @@ + + + ## kops replace Replace cluster resources. diff --git a/docs/cli/kops_rolling-update.md b/docs/cli/kops_rolling-update.md index e6a0dc8c3c..ea44fdec6c 100644 --- a/docs/cli/kops_rolling-update.md +++ b/docs/cli/kops_rolling-update.md @@ -1,3 +1,6 @@ + + + ## 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 index 8458a324b6..c7e059f2f4 100644 --- a/docs/cli/kops_rolling-update_cluster.md +++ b/docs/cli/kops_rolling-update_cluster.md @@ -1,3 +1,6 @@ + + + ## kops rolling-update cluster Rolling update a cluster. diff --git a/docs/cli/kops_toolbox.md b/docs/cli/kops_toolbox.md index 7d4a6301ad..b35910ae5c 100644 --- a/docs/cli/kops_toolbox.md +++ b/docs/cli/kops_toolbox.md @@ -1,3 +1,6 @@ + + + ## kops toolbox Misc infrequently used commands. diff --git a/docs/cli/kops_toolbox_convert-imported.md b/docs/cli/kops_toolbox_convert-imported.md index 0d46e44f3b..08ea448366 100644 --- a/docs/cli/kops_toolbox_convert-imported.md +++ b/docs/cli/kops_toolbox_convert-imported.md @@ -1,3 +1,6 @@ + + + ## 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 index 298ca7b4e6..07d7e5db30 100644 --- a/docs/cli/kops_toolbox_dump.md +++ b/docs/cli/kops_toolbox_dump.md @@ -1,3 +1,6 @@ + + + ## kops toolbox dump Dump cluster information diff --git a/docs/cli/kops_update.md b/docs/cli/kops_update.md index 4f3259c614..41bc9e704f 100644 --- a/docs/cli/kops_update.md +++ b/docs/cli/kops_update.md @@ -1,3 +1,6 @@ + + + ## kops update Update a cluster. diff --git a/docs/cli/kops_update_cluster.md b/docs/cli/kops_update_cluster.md index 668c499659..ad0b224cb3 100644 --- a/docs/cli/kops_update_cluster.md +++ b/docs/cli/kops_update_cluster.md @@ -1,3 +1,6 @@ + + + ## kops update cluster Update a cluster. diff --git a/docs/cli/kops_update_federation.md b/docs/cli/kops_update_federation.md index 560b8cf00c..a0b5d9e75f 100644 --- a/docs/cli/kops_update_federation.md +++ b/docs/cli/kops_update_federation.md @@ -1,3 +1,6 @@ + + + ## kops update federation Update federation cluster resources. diff --git a/docs/cli/kops_upgrade.md b/docs/cli/kops_upgrade.md index 5733c47479..7018500723 100644 --- a/docs/cli/kops_upgrade.md +++ b/docs/cli/kops_upgrade.md @@ -1,3 +1,6 @@ + + + ## kops upgrade Upgrade a kubernetes cluster. diff --git a/docs/cli/kops_upgrade_cluster.md b/docs/cli/kops_upgrade_cluster.md index 0e7c539540..1a36e56c71 100644 --- a/docs/cli/kops_upgrade_cluster.md +++ b/docs/cli/kops_upgrade_cluster.md @@ -1,3 +1,6 @@ + + + ## kops upgrade cluster Upgrade a kubernetes cluster. diff --git a/docs/cli/kops_validate.md b/docs/cli/kops_validate.md index c9c0febf9a..fb441f969f 100644 --- a/docs/cli/kops_validate.md +++ b/docs/cli/kops_validate.md @@ -1,3 +1,6 @@ + + + ## kops validate Validate a kops cluster. diff --git a/docs/cli/kops_validate_cluster.md b/docs/cli/kops_validate_cluster.md index c779a6c3f3..2ee4556228 100644 --- a/docs/cli/kops_validate_cluster.md +++ b/docs/cli/kops_validate_cluster.md @@ -1,3 +1,6 @@ + + + ## kops validate cluster Validate a kops cluster. diff --git a/docs/cli/kops_version.md b/docs/cli/kops_version.md index 275ec5bae1..f6fdcd25f4 100644 --- a/docs/cli/kops_version.md +++ b/docs/cli/kops_version.md @@ -1,3 +1,6 @@ + + + ## kops version Print the kops version information.