diff --git a/Makefile b/Makefile index 1d2a5301..a6f024a6 100644 --- a/Makefile +++ b/Makefile @@ -56,7 +56,7 @@ release-local: install-build-deps docs: rm -rf docs mkdir docs - go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms-cli'" hack/gendocs/main.go + go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms-cli'" hack/gendocs/main.go cp docs/oms-cli.md docs/README.md generate-license: generate diff --git a/docs/README.md b/docs/README.md index 287d68d6..a172e71e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -28,4 +28,3 @@ like downloading new versions. * [oms-cli update](oms-cli_update.md) - Update OMS related resources * [oms-cli version](oms-cli_version.md) - Print version -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli.md b/docs/oms-cli.md index 287d68d6..a172e71e 100644 --- a/docs/oms-cli.md +++ b/docs/oms-cli.md @@ -28,4 +28,3 @@ like downloading new versions. * [oms-cli update](oms-cli_update.md) - Update OMS related resources * [oms-cli version](oms-cli_version.md) - Print version -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_beta.md b/docs/oms-cli_beta.md index 4ff926b2..6952fda5 100644 --- a/docs/oms-cli_beta.md +++ b/docs/oms-cli_beta.md @@ -18,4 +18,3 @@ Be aware that that usage and behavior may change as the features are developed. * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) * [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images. -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_beta_extend.md b/docs/oms-cli_beta_extend.md index 1aba5fee..95bc3e63 100644 --- a/docs/oms-cli_beta_extend.md +++ b/docs/oms-cli_beta_extend.md @@ -17,4 +17,3 @@ Extend Codesphere ressources such as base images to customize them for your need * [oms-cli beta](oms-cli_beta.md) - Commands for early testing * [oms-cli beta extend baseimage](oms-cli_beta_extend_baseimage.md) - Extend Codesphere's workspace base image for customization -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_beta_extend_baseimage.md b/docs/oms-cli_beta_extend_baseimage.md index e0d3298d..50b8fa19 100644 --- a/docs/oms-cli_beta_extend_baseimage.md +++ b/docs/oms-cli_beta_extend_baseimage.md @@ -28,4 +28,3 @@ oms-cli beta extend baseimage [flags] * [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images. -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_build.md b/docs/oms-cli_build.md index 717d0fba..76481ada 100644 --- a/docs/oms-cli_build.md +++ b/docs/oms-cli_build.md @@ -18,4 +18,3 @@ Build and push container images to a registry using the provided configuration. * [oms-cli build image](oms-cli_build_image.md) - Build and push Docker image using Dockerfile and Codesphere package version * [oms-cli build images](oms-cli_build_images.md) - Build and push container images -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_build_image.md b/docs/oms-cli_build_image.md index 599bb207..bc55ea4a 100644 --- a/docs/oms-cli_build_image.md +++ b/docs/oms-cli_build_image.md @@ -32,4 +32,3 @@ $ oms-cli build image --dockerfile baseimage/Dockerfile --package codesphere-v1. * [oms-cli build](oms-cli_build.md) - Build and push images to a registry -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_build_images.md b/docs/oms-cli_build_images.md index f3bbee92..a2f5e409 100644 --- a/docs/oms-cli_build_images.md +++ b/docs/oms-cli_build_images.md @@ -23,4 +23,3 @@ oms-cli build images [flags] * [oms-cli build](oms-cli_build.md) - Build and push images to a registry -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_download.md b/docs/oms-cli_download.md index e70e4a24..fff85d97 100644 --- a/docs/oms-cli_download.md +++ b/docs/oms-cli_download.md @@ -18,4 +18,3 @@ e.g. available Codesphere packages * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) * [oms-cli download package](oms-cli_download_package.md) - Download a codesphere package -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_download_package.md b/docs/oms-cli_download_package.md index 2f244957..7f1ee1b1 100644 --- a/docs/oms-cli_download_package.md +++ b/docs/oms-cli_download_package.md @@ -36,4 +36,3 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta * [oms-cli download](oms-cli_download.md) - Download resources available through OMS -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_install.md b/docs/oms-cli_install.md index 456ae26e..f63765b8 100644 --- a/docs/oms-cli_install.md +++ b/docs/oms-cli_install.md @@ -17,4 +17,3 @@ Coming soon: Install Codesphere and other components like Ceph and PostgreSQL. * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) * [oms-cli install codesphere](oms-cli_install_codesphere.md) - Install a Codesphere instance -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_install_codesphere.md b/docs/oms-cli_install_codesphere.md index 8f210ea7..f2df7677 100644 --- a/docs/oms-cli_install_codesphere.md +++ b/docs/oms-cli_install_codesphere.md @@ -26,4 +26,3 @@ oms-cli install codesphere [flags] * [oms-cli install](oms-cli_install.md) - Coming soon: Install Codesphere and other components -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_licenses.md b/docs/oms-cli_licenses.md index 560dcf9c..d6e1487b 100644 --- a/docs/oms-cli_licenses.md +++ b/docs/oms-cli_licenses.md @@ -20,4 +20,3 @@ oms-cli licenses [flags] * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_list.md b/docs/oms-cli_list.md index 87578937..0d5a7c4b 100644 --- a/docs/oms-cli_list.md +++ b/docs/oms-cli_list.md @@ -19,4 +19,3 @@ eg. available Codesphere packages * [oms-cli list api-keys](oms-cli_list_api-keys.md) - List API keys * [oms-cli list packages](oms-cli_list_packages.md) - List available packages -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_list_api-keys.md b/docs/oms-cli_list_api-keys.md index 28919aa7..dd7b1c41 100644 --- a/docs/oms-cli_list_api-keys.md +++ b/docs/oms-cli_list_api-keys.md @@ -20,4 +20,3 @@ oms-cli list api-keys [flags] * [oms-cli list](oms-cli_list.md) - List resources available through OMS -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_list_packages.md b/docs/oms-cli_list_packages.md index 6b8623ae..1b2ae8bf 100644 --- a/docs/oms-cli_list_packages.md +++ b/docs/oms-cli_list_packages.md @@ -20,4 +20,3 @@ oms-cli list packages [flags] * [oms-cli list](oms-cli_list.md) - List resources available through OMS -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_register.md b/docs/oms-cli_register.md index cf1c417b..a2438b90 100644 --- a/docs/oms-cli_register.md +++ b/docs/oms-cli_register.md @@ -24,4 +24,3 @@ oms-cli register [flags] * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_revoke.md b/docs/oms-cli_revoke.md index 5fb347d8..dcab1d81 100644 --- a/docs/oms-cli_revoke.md +++ b/docs/oms-cli_revoke.md @@ -18,4 +18,3 @@ eg. api keys. * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) * [oms-cli revoke api-key](oms-cli_revoke_api-key.md) - Revoke an API key -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_revoke_api-key.md b/docs/oms-cli_revoke_api-key.md index e753b04a..45524164 100644 --- a/docs/oms-cli_revoke_api-key.md +++ b/docs/oms-cli_revoke_api-key.md @@ -21,4 +21,3 @@ oms-cli revoke api-key [flags] * [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_update.md b/docs/oms-cli_update.md index ed9a3a5e..817b510f 100644 --- a/docs/oms-cli_update.md +++ b/docs/oms-cli_update.md @@ -24,4 +24,3 @@ oms-cli update [flags] * [oms-cli update oms](oms-cli_update_oms.md) - Update the OMS CLI * [oms-cli update package](oms-cli_update_package.md) - Download a codesphere package -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_update_api-key.md b/docs/oms-cli_update_api-key.md index 63f2782a..4948844a 100644 --- a/docs/oms-cli_update_api-key.md +++ b/docs/oms-cli_update_api-key.md @@ -22,4 +22,3 @@ oms-cli update api-key [flags] * [oms-cli update](oms-cli_update.md) - Update OMS related resources -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_update_dockerfile.md b/docs/oms-cli_update_dockerfile.md index 0e94b3ed..f127c12b 100644 --- a/docs/oms-cli_update_dockerfile.md +++ b/docs/oms-cli_update_dockerfile.md @@ -38,4 +38,3 @@ $ oms-cli update dockerfile --dockerfile baseimage/Dockerfile --package codesphe * [oms-cli update](oms-cli_update.md) - Update OMS related resources -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_update_oms.md b/docs/oms-cli_update_oms.md index 9712bceb..1a481d7d 100644 --- a/docs/oms-cli_update_oms.md +++ b/docs/oms-cli_update_oms.md @@ -20,4 +20,3 @@ oms-cli update oms [flags] * [oms-cli update](oms-cli_update.md) - Update OMS related resources -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_update_package.md b/docs/oms-cli_update_package.md index 7194bb76..03bf25e4 100644 --- a/docs/oms-cli_update_package.md +++ b/docs/oms-cli_update_package.md @@ -36,4 +36,3 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta * [oms-cli update](oms-cli_update.md) - Update OMS related resources -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/docs/oms-cli_version.md b/docs/oms-cli_version.md index 703e2dbe..17daf6ef 100644 --- a/docs/oms-cli_version.md +++ b/docs/oms-cli_version.md @@ -20,4 +20,3 @@ oms-cli version [flags] * [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -###### Auto generated by spf13/cobra on 7-Nov-2025 diff --git a/hack/gendocs/main.go b/hack/gendocs/main.go index b0365588..a59cd3a0 100644 --- a/hack/gendocs/main.go +++ b/hack/gendocs/main.go @@ -15,7 +15,11 @@ func main() { root := oms.GetRootCmd() root.Use = "oms-cli" - err := doc.GenMarkdownTree(root, "docs") + root.DisableAutoGenTag = true + + identity := func(s string) string { return s } + emptyStr := func(s string) string { return "" } + err := doc.GenMarkdownTreeCustom(root, "docs", emptyStr, identity) if err != nil { log.Fatal(err) }