Skip to content

hack/doc,doc/cli: disable and remove autogen tag #2169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 7, 2019
Merged

hack/doc,doc/cli: disable and remove autogen tag #2169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/cli/operator-sdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ An SDK for building operators with ease
* [operator-sdk up](operator-sdk_up.md) - Launches the operator
* [operator-sdk version](operator-sdk_version.md) - Prints the version of operator-sdk

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ Adds a controller or resource to the project
* [operator-sdk add controller](operator-sdk_add_controller.md) - Adds a new controller pkg
* [operator-sdk add crd](operator-sdk_add_crd.md) - Adds a Custom Resource Definition (CRD) and the Custom Resource (CR) files

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_add_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,3 @@ operator-sdk add api [flags]

* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_add_controller.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ operator-sdk add controller [flags]

* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_add_crd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ operator-sdk add crd [flags]

* [operator-sdk add](operator-sdk_add.md) - Adds a controller or resource to the project

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_alpha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,3 @@ Run an alpha subcommand
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_alpha_olm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ Manage the Operator Lifecycle Manager installation in your cluster
* [operator-sdk alpha olm status](operator-sdk_alpha_olm_status.md) - Get the status of the Operator Lifecycle Manager installation in your cluster
* [operator-sdk alpha olm uninstall](operator-sdk_alpha_olm_uninstall.md) - Uninstall Operator Lifecycle Manager from your cluster

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_alpha_olm_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@ operator-sdk alpha olm install [flags]

* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_alpha_olm_status.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ operator-sdk alpha olm status [flags]

* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_alpha_olm_uninstall.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ operator-sdk alpha olm uninstall [flags]

* [operator-sdk alpha olm](operator-sdk_alpha_olm.md) - Manage the Operator Lifecycle Manager installation in your cluster

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,3 @@ operator-sdk build <image> [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ Generators for shell completions
* [operator-sdk completion bash](operator-sdk_completion_bash.md) - Generate bash completions
* [operator-sdk completion zsh](operator-sdk_completion_zsh.md) - Generate zsh completions

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_completion_bash.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ operator-sdk completion bash [flags]

* [operator-sdk completion](operator-sdk_completion.md) - Generators for shell completions

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_completion_zsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ operator-sdk completion zsh [flags]

* [operator-sdk completion](operator-sdk_completion.md) - Generators for shell completions

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_generate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ The operator-sdk generate command invokes specific generator to generate code as
* [operator-sdk generate k8s](operator-sdk_generate_k8s.md) - Generates Kubernetes code for custom resource
* [operator-sdk generate openapi](operator-sdk_generate_openapi.md) - Generates OpenAPI specs for API's

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_generate_k8s.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ operator-sdk generate k8s [flags]

* [operator-sdk generate](operator-sdk_generate.md) - Invokes specific generator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_generate_openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ operator-sdk generate openapi [flags]

* [operator-sdk generate](operator-sdk_generate.md) - Invokes specific generator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_migrate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@ operator-sdk migrate [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,3 @@ operator-sdk new <project-name> [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_olm-catalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ Catalog related actions.
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
* [operator-sdk olm-catalog gen-csv](operator-sdk_olm-catalog_gen-csv.md) - Generates a Cluster Service Version yaml file for the operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_olm-catalog_gen-csv.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,3 @@ operator-sdk olm-catalog gen-csv [flags]

* [operator-sdk olm-catalog](operator-sdk_olm-catalog.md) - Invokes a olm-catalog command

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_print-deps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ operator-sdk print-deps [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ should use "up local" instead.
* [operator-sdk run ansible](operator-sdk_run_ansible.md) - Runs as an ansible operator
* [operator-sdk run helm](operator-sdk_run_helm.md) - Runs as a helm operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_run_ansible.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ operator-sdk run ansible [flags]

* [operator-sdk run](operator-sdk_run.md) - Runs a generic operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_run_helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,3 @@ operator-sdk run helm [flags]

* [operator-sdk run](operator-sdk_run.md) - Runs a generic operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_scorecard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ operator-sdk scorecard [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_test.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ The test command has subcommands that can test the operator.
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
* [operator-sdk test local](operator-sdk_test_local.md) - Run End-To-End tests locally

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_test_local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,3 @@ operator-sdk test local <path to tests directory> [flags]

* [operator-sdk test](operator-sdk_test.md) - Tests the operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_up.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ The up command has subcommands that can launch the operator in various ways.
* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease
* [operator-sdk up local](operator-sdk_up_local.md) - Launches the operator locally

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_up_local.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ operator-sdk up local [flags]

* [operator-sdk up](operator-sdk_up.md) - Launches the operator

###### Auto generated by spf13/cobra on 6-Nov-2019
1 change: 0 additions & 1 deletion doc/cli/operator-sdk_version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ operator-sdk version [flags]

* [operator-sdk](operator-sdk.md) - An SDK for building operators with ease

###### Auto generated by spf13/cobra on 6-Nov-2019
2 changes: 2 additions & 0 deletions hack/doc/gen-cli-doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ import (

func main() {
root := cli.GetCLIRoot()
root.DisableAutoGenTag = true

currentDir, err := os.Getwd()
if err != nil {
log.Fatalf("Failed to get current directory: %v", err)
Expand Down