From 541b21f78546a3f95e4030fa8d2c13bfe9b383ba Mon Sep 17 00:00:00 2001 From: rad-ci-bot Date: Wed, 30 Aug 2023 18:12:28 +0000 Subject: [PATCH] Autogenerate rad CLI reference docs --- docs/content/reference/cli/rad.md | 2 +- .../reference/cli/rad_credential_register_azure.md | 2 +- docs/content/reference/cli/rad_recipe.md | 6 +++--- docs/content/reference/cli/rad_recipe_list.md | 2 +- docs/content/reference/cli/rad_recipe_register.md | 10 +++++----- docs/content/reference/cli/rad_recipe_show.md | 2 +- docs/content/reference/cli/rad_recipe_unregister.md | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/content/reference/cli/rad.md b/docs/content/reference/cli/rad.md index 4b2e4d488..3ade4ad09 100644 --- a/docs/content/reference/cli/rad.md +++ b/docs/content/reference/cli/rad.md @@ -34,7 +34,7 @@ Radius CLI * [rad group]({{< ref rad_group.md >}}) - Manage resource groups * [rad init]({{< ref rad_init.md >}}) - Initialize Radius * [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes * [rad resource]({{< ref rad_resource.md >}}) - Manage resources * [rad run]({{< ref rad_run.md >}}) - Run an application * [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform diff --git a/docs/content/reference/cli/rad_credential_register_azure.md b/docs/content/reference/cli/rad_credential_register_azure.md index 964b9608e..7e476fa6b 100644 --- a/docs/content/reference/cli/rad_credential_register_azure.md +++ b/docs/content/reference/cli/rad_credential_register_azure.md @@ -18,7 +18,7 @@ This command is intended for scripting or advanced use-cases. See 'rad init' for to configure these settings. Radius will use the provided service principal for all interactions with Azure, including Bicep deployment, -Radius environments, and Radius links. +Radius environments, and Radius portable resources. Radius will use the provided subscription and resource group as the default target scope for Bicep deployment. The provided service principal must have the Contributor or Owner role assigned for the provided resource group diff --git a/docs/content/reference/cli/rad_recipe.md b/docs/content/reference/cli/rad_recipe.md index 3973b63c4..4ed4bdd4a 100644 --- a/docs/content/reference/cli/rad_recipe.md +++ b/docs/content/reference/cli/rad_recipe.md @@ -8,12 +8,12 @@ description: "Details on the rad recipe Radius CLI command" --- ## rad recipe -Manage link recipes +Manage recipes ### Synopsis -Manage link recipes - Link recipes automate the deployment of infrastructure and configuration of links. +Manage recipes + Recipes automate the deployment of infrastructure and configuration of portable resources. ### Options diff --git a/docs/content/reference/cli/rad_recipe_list.md b/docs/content/reference/cli/rad_recipe_list.md index 0c633e86c..4ca115d65 100644 --- a/docs/content/reference/cli/rad_recipe_list.md +++ b/docs/content/reference/cli/rad_recipe_list.md @@ -42,5 +42,5 @@ rad recipe list ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_register.md b/docs/content/reference/cli/rad_recipe_register.md index 37541a81c..13cb835a3 100644 --- a/docs/content/reference/cli/rad_recipe_register.md +++ b/docs/content/reference/cli/rad_recipe_register.md @@ -28,13 +28,13 @@ rad recipe register [recipe-name] [flags] ``` # Add a recipe to an environment -rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases +rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases # Specify a parameter -rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases --parameters throughput=400 +rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters throughput=400 # specify multiple parameters using a JSON parameter file -rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Link/mongoDatabases --parameters @myfile.json +rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --template-path template_path --link-type Applications.Datastores/mongoDatabases --parameters @myfile.json ``` @@ -44,7 +44,7 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te -e, --environment string The environment name -g, --group string The resource group name -h, --help help for register - --link-type string specify the type of the link this recipe can be consumed by + --link-type string specify the type of the portable resource this recipe can be consumed by -o, --output string output format (supported formats are json, table) (default "table") -p, --parameters stringArray Specify parameters for the deployment --template-kind string specify the kind for the template provided by the recipe. @@ -61,5 +61,5 @@ rad recipe register cosmosdb -e env_name -w workspace --template-kind bicep --te ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_show.md b/docs/content/reference/cli/rad_recipe_show.md index 157c965e4..8d3ebfb9d 100644 --- a/docs/content/reference/cli/rad_recipe_show.md +++ b/docs/content/reference/cli/rad_recipe_show.md @@ -57,5 +57,5 @@ rad recipe show redis-dev --group dev --environment dev ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes diff --git a/docs/content/reference/cli/rad_recipe_unregister.md b/docs/content/reference/cli/rad_recipe_unregister.md index c4a813575..1299718a8 100644 --- a/docs/content/reference/cli/rad_recipe_unregister.md +++ b/docs/content/reference/cli/rad_recipe_unregister.md @@ -43,5 +43,5 @@ rad recipe unregister cosmosdb ### SEE ALSO -* [rad recipe]({{< ref rad_recipe.md >}}) - Manage link recipes +* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes