From faa6138929b15b8e5adfee17bfb33dbc05830277 Mon Sep 17 00:00:00 2001 From: rad-ci-bot Date: Thu, 19 Dec 2024 22:10:55 +0000 Subject: [PATCH] Autogenerate reference docs Signed-off-by: rad-ci-bot --- docs/content/reference/cli/rad.md | 4 +- .../reference/cli/rad_application_graph.md | 1 - docs/content/reference/cli/rad_env.md | 42 ------------------- docs/content/reference/cli/rad_environment.md | 42 +++++++++++++++++++ ...nv_create.md => rad_environment_create.md} | 16 +++---- ...nv_delete.md => rad_environment_delete.md} | 16 +++---- ...ad_env_list.md => rad_environment_list.md} | 16 +++---- ...ad_env_show.md => rad_environment_show.md} | 16 +++---- ...nv_switch.md => rad_environment_switch.md} | 16 +++---- ...nv_update.md => rad_environment_update.md} | 16 +++---- .../cli/{rad_init.md => rad_initialize.md} | 16 +++---- .../cli/rad_resource-provider_create.md | 7 +++- 12 files changed, 105 insertions(+), 103 deletions(-) delete mode 100644 docs/content/reference/cli/rad_env.md create mode 100644 docs/content/reference/cli/rad_environment.md rename docs/content/reference/cli/{rad_env_create.md => rad_environment_create.md} (69%) rename docs/content/reference/cli/{rad_env_delete.md => rad_environment_delete.md} (72%) rename docs/content/reference/cli/{rad_env_list.md => rad_environment_list.md} (64%) rename docs/content/reference/cli/{rad_env_show.md => rad_environment_show.md} (69%) rename docs/content/reference/cli/{rad_env_switch.md => rad_environment_switch.md} (59%) rename docs/content/reference/cli/{rad_env_update.md => rad_environment_update.md} (82%) rename docs/content/reference/cli/{rad_init.md => rad_initialize.md} (82%) diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index b46b19a90..3b442dd2d 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -30,9 +30,9 @@ Radius CLI * [rad credential]({{< ref rad_credential.md >}}) - Manage cloud provider credential for a Radius installation. * [rad debug-logs]({{< ref rad_debug-logs.md >}}) - Capture logs from Radius control plane for debugging and diagnostics. * [rad deploy]({{< ref rad_deploy.md >}}) - Deploy a template -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments * [rad group]({{< ref rad_group.md >}}) - Manage resource groups -* [rad init]({{< ref rad_init.md >}}) - Initialize Radius +* [rad initialize]({{< ref rad_initialize.md >}}) - Initialize Radius * [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform * [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes * [rad resource]({{< ref rad_resource.md >}}) - Manage resources diff --git a/docs/content/reference/cli/rad_application_graph.md b/docs/content/reference/cli/rad_application_graph.md index da4e1cbe5..7c53ec18d 100644 --- a/docs/content/reference/cli/rad_application_graph.md +++ b/docs/content/reference/cli/rad_application_graph.md @@ -33,7 +33,6 @@ rad app graph my-application ``` -a, --application string The application name - -e, --environment string The environment name -g, --group string The resource group name -h, --help help for graph -w, --workspace string The workspace name diff --git a/docs/content/reference/cli/rad_env.md b/docs/content/reference/cli/rad_env.md deleted file mode 100644 index 359aa5e6c..000000000 --- a/docs/content/reference/cli/rad_env.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -type: docs -title: "rad env CLI reference" -linkTitle: "rad env" -slug: rad_env -url: /reference/cli/rad_env/ -description: "Details on the rad env Radius CLI command" ---- -## rad env - -Manage Radius Environments - -### Synopsis - -Manage Radius Environments -Radius Environments are prepared “landing zones” for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. - -### Options - -``` - -e, --environment string The environment name - -h, --help help for env - -w, --workspace string The workspace name -``` - -### Options inherited from parent commands - -``` - --config string config file (default "$HOME/.rad/config.yaml") - -o, --output string output format (supported formats are json, table) (default "table") -``` - -### SEE ALSO - -* [rad]({{< ref rad.md >}}) - Radius CLI -* [rad env create]({{< ref rad_env_create.md >}}) - Create a new Radius Environment -* [rad env delete]({{< ref rad_env_delete.md >}}) - Delete environment -* [rad env list]({{< ref rad_env_list.md >}}) - List environments -* [rad env show]({{< ref rad_env_show.md >}}) - Show environment details -* [rad env switch]({{< ref rad_env_switch.md >}}) - Switch the current environment -* [rad env update]({{< ref rad_env_update.md >}}) - Update environment configuration - diff --git a/docs/content/reference/cli/rad_environment.md b/docs/content/reference/cli/rad_environment.md new file mode 100644 index 000000000..98ea40020 --- /dev/null +++ b/docs/content/reference/cli/rad_environment.md @@ -0,0 +1,42 @@ +--- +type: docs +title: "rad environment CLI reference" +linkTitle: "rad environment" +slug: rad_environment +url: /reference/cli/rad_environment/ +description: "Details on the rad environment Radius CLI command" +--- +## rad environment + +Manage Radius Environments + +### Synopsis + +Manage Radius Environments +Radius Environments are prepared “landing zones” for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. + +### Options + +``` + -e, --environment string The environment name + -h, --help help for environment + -w, --workspace string The workspace name +``` + +### Options inherited from parent commands + +``` + --config string config file (default "$HOME/.rad/config.yaml") + -o, --output string output format (supported formats are json, table) (default "table") +``` + +### SEE ALSO + +* [rad]({{< ref rad.md >}}) - Radius CLI +* [rad environment create]({{< ref rad_environment_create.md >}}) - Create a new Radius Environment +* [rad environment delete]({{< ref rad_environment_delete.md >}}) - Delete environment +* [rad environment list]({{< ref rad_environment_list.md >}}) - List environments +* [rad environment show]({{< ref rad_environment_show.md >}}) - Show environment details +* [rad environment switch]({{< ref rad_environment_switch.md >}}) - Switch the current environment +* [rad environment update]({{< ref rad_environment_update.md >}}) - Update environment configuration + diff --git a/docs/content/reference/cli/rad_env_create.md b/docs/content/reference/cli/rad_environment_create.md similarity index 69% rename from docs/content/reference/cli/rad_env_create.md rename to docs/content/reference/cli/rad_environment_create.md index 51bdf1e29..227f6bf49 100644 --- a/docs/content/reference/cli/rad_env_create.md +++ b/docs/content/reference/cli/rad_environment_create.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env create CLI reference" -linkTitle: "rad env create" -slug: rad_env_create -url: /reference/cli/rad_env_create/ -description: "Details on the rad env create Radius CLI command" +title: "rad environment create CLI reference" +linkTitle: "rad environment create" +slug: rad_environment_create +url: /reference/cli/rad_environment_create/ +description: "Details on the rad environment create Radius CLI command" --- -## rad env create +## rad environment create Create a new Radius Environment @@ -17,7 +17,7 @@ Radius Environments are prepared "landing zones" for Radius Applications. Applications deployed to an environment will inherit the container runtime, configuration, and other settings from the environment. ``` -rad env create [envName] [flags] +rad environment create [envName] [flags] ``` ### Examples @@ -45,5 +45,5 @@ rad env create myenv ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_delete.md b/docs/content/reference/cli/rad_environment_delete.md similarity index 72% rename from docs/content/reference/cli/rad_env_delete.md rename to docs/content/reference/cli/rad_environment_delete.md index 04b170eaa..dc3b1e2de 100644 --- a/docs/content/reference/cli/rad_env_delete.md +++ b/docs/content/reference/cli/rad_environment_delete.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env delete CLI reference" -linkTitle: "rad env delete" -slug: rad_env_delete -url: /reference/cli/rad_env_delete/ -description: "Details on the rad env delete Radius CLI command" +title: "rad environment delete CLI reference" +linkTitle: "rad environment delete" +slug: rad_environment_delete +url: /reference/cli/rad_environment_delete/ +description: "Details on the rad environment delete Radius CLI command" --- -## rad env delete +## rad environment delete Delete environment @@ -15,7 +15,7 @@ Delete environment Delete environment. Deletes the user's default environment by default. ``` -rad env delete [flags] +rad environment delete [flags] ``` ### Examples @@ -55,5 +55,5 @@ rad env delete my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_list.md b/docs/content/reference/cli/rad_environment_list.md similarity index 64% rename from docs/content/reference/cli/rad_env_list.md rename to docs/content/reference/cli/rad_environment_list.md index 0d611390c..ca9428295 100644 --- a/docs/content/reference/cli/rad_env_list.md +++ b/docs/content/reference/cli/rad_environment_list.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env list CLI reference" -linkTitle: "rad env list" -slug: rad_env_list -url: /reference/cli/rad_env_list/ -description: "Details on the rad env list Radius CLI command" +title: "rad environment list CLI reference" +linkTitle: "rad environment list" +slug: rad_environment_list +url: /reference/cli/rad_environment_list/ +description: "Details on the rad environment list Radius CLI command" --- -## rad env list +## rad environment list List environments @@ -15,7 +15,7 @@ List environments List environments using the current, or specified workspace. ``` -rad env list [flags] +rad environment list [flags] ``` ### Examples @@ -45,5 +45,5 @@ rad env list ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_show.md b/docs/content/reference/cli/rad_environment_show.md similarity index 69% rename from docs/content/reference/cli/rad_env_show.md rename to docs/content/reference/cli/rad_environment_show.md index 2da835a0f..f1a0822f2 100644 --- a/docs/content/reference/cli/rad_env_show.md +++ b/docs/content/reference/cli/rad_environment_show.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env show CLI reference" -linkTitle: "rad env show" -slug: rad_env_show -url: /reference/cli/rad_env_show/ -description: "Details on the rad env show Radius CLI command" +title: "rad environment show CLI reference" +linkTitle: "rad environment show" +slug: rad_environment_show +url: /reference/cli/rad_environment_show/ +description: "Details on the rad environment show Radius CLI command" --- -## rad env show +## rad environment show Show environment details @@ -15,7 +15,7 @@ Show environment details Show environment details. Shows the user's default environment by default. ``` -rad env show [flags] +rad environment show [flags] ``` ### Examples @@ -51,5 +51,5 @@ rad env show my-env --group my-env ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_switch.md b/docs/content/reference/cli/rad_environment_switch.md similarity index 59% rename from docs/content/reference/cli/rad_env_switch.md rename to docs/content/reference/cli/rad_environment_switch.md index 995e21b8f..5f6d289b3 100644 --- a/docs/content/reference/cli/rad_env_switch.md +++ b/docs/content/reference/cli/rad_environment_switch.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env switch CLI reference" -linkTitle: "rad env switch" -slug: rad_env_switch -url: /reference/cli/rad_env_switch/ -description: "Details on the rad env switch Radius CLI command" +title: "rad environment switch CLI reference" +linkTitle: "rad environment switch" +slug: rad_environment_switch +url: /reference/cli/rad_environment_switch/ +description: "Details on the rad environment switch Radius CLI command" --- -## rad env switch +## rad environment switch Switch the current environment @@ -15,7 +15,7 @@ Switch the current environment Switch the current environment ``` -rad env switch [environment] [flags] +rad environment switch [environment] [flags] ``` ### Examples @@ -41,5 +41,5 @@ rad env switch newEnvironment ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_env_update.md b/docs/content/reference/cli/rad_environment_update.md similarity index 82% rename from docs/content/reference/cli/rad_env_update.md rename to docs/content/reference/cli/rad_environment_update.md index f6ca94c69..fbbaaf53e 100644 --- a/docs/content/reference/cli/rad_env_update.md +++ b/docs/content/reference/cli/rad_environment_update.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad env update CLI reference" -linkTitle: "rad env update" -slug: rad_env_update -url: /reference/cli/rad_env_update/ -description: "Details on the rad env update Radius CLI command" +title: "rad environment update CLI reference" +linkTitle: "rad environment update" +slug: rad_environment_update +url: /reference/cli/rad_environment_update/ +description: "Details on the rad environment update Radius CLI command" --- -## rad env update +## rad environment update Update environment configuration @@ -23,7 +23,7 @@ All other properties require the environment to be deleted and recreated. ``` -rad env update [environment] [flags] +rad environment update [environment] [flags] ``` ### Examples @@ -68,5 +68,5 @@ rad env update myenv --clear-aws ### SEE ALSO -* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments +* [rad environment]({{< ref rad_environment.md >}}) - Manage Radius Environments diff --git a/docs/content/reference/cli/rad_init.md b/docs/content/reference/cli/rad_initialize.md similarity index 82% rename from docs/content/reference/cli/rad_init.md rename to docs/content/reference/cli/rad_initialize.md index 4e19fe7b1..d36954d59 100644 --- a/docs/content/reference/cli/rad_init.md +++ b/docs/content/reference/cli/rad_initialize.md @@ -1,12 +1,12 @@ --- type: docs -title: "rad init CLI reference" -linkTitle: "rad init" -slug: rad_init -url: /reference/cli/rad_init/ -description: "Details on the rad init Radius CLI command" +title: "rad initialize CLI reference" +linkTitle: "rad initialize" +slug: rad_initialize +url: /reference/cli/rad_initialize/ +description: "Details on the rad initialize Radius CLI command" --- -## rad init +## rad initialize Initialize Radius @@ -23,7 +23,7 @@ Specifying the '--full' flag will cause 'rad init' to prompt the user for all av ``` -rad init [flags] +rad initialize [flags] ``` ### Examples @@ -42,7 +42,7 @@ rad init --full ``` --full Prompt user for all available configuration options - -h, --help help for init + -h, --help help for initialize -o, --output string output format (supported formats are json, table) (default "table") ``` diff --git a/docs/content/reference/cli/rad_resource-provider_create.md b/docs/content/reference/cli/rad_resource-provider_create.md index 47ddd323e..cfd0b8810 100644 --- a/docs/content/reference/cli/rad_resource-provider_create.md +++ b/docs/content/reference/cli/rad_resource-provider_create.md @@ -18,7 +18,7 @@ Resource providers are the entities that implement resource types such as 'Appli Creating a resource provider defines new resource types that can be used in applications. -Input can be passed in using a file or inline JSON as the second argument. Prefix the input with '@' to indicate a file path. +Input can be passed in using a JSON or YAML file using the --from-file option. ``` @@ -29,9 +29,12 @@ rad resource-provider create [input] [flags] ``` -# Create a resource provider +# Create a resource provider from YAML file rad resource-provider create --from-file /path/to/input.yaml +# Create a resource provider from JSON file +rad resource-provider create --from-file /path/to/input.json + ``` ### Options