Skip to content

Commit

Permalink
Autogenerate rad CLI reference docs (#830)
Browse files Browse the repository at this point in the history
Co-authored-by: rad-ci-bot <[email protected]>
  • Loading branch information
rad-ci-bot and rad-ci-bot authored Oct 11, 2023
1 parent 6c72a71 commit 230dd04
Show file tree
Hide file tree
Showing 27 changed files with 58 additions and 58 deletions.
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ Radius CLI

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications
* [rad bicep]({{< ref rad_bicep.md >}}) - Manage bicep compiler
* [rad completion]({{< ref rad_completion.md >}}) - Generates shell completion scripts
* [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 env]({{< ref rad_env.md >}}) - Manage Radius Environments
* [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
Expand Down
14 changes: 7 additions & 7 deletions docs/content/reference/cli/rad_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application Radius CLI command"
---
## rad application

Manage Radius applications
Manage Radius Applications

### Synopsis

Manage Radius applications
Manage Radius Applications

### Options

Expand All @@ -31,9 +31,9 @@ Manage Radius applications

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad application connections]({{< ref rad_application_connections.md >}}) - Shows the connections for an application.
* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius application
* [rad application list]({{< ref rad_application_list.md >}}) - List Radius applications
* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius application details
* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius application status
* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius application
* [rad application delete]({{< ref rad_application_delete.md >}}) - Delete Radius Application
* [rad application list]({{< ref rad_application_list.md >}}) - List Radius Applications
* [rad application show]({{< ref rad_application_show.md >}}) - Show Radius Application details
* [rad application status]({{< ref rad_application_status.md >}}) - Show Radius Application status
* [rad application switch]({{< ref rad_application_switch.md >}}) - Switch the default Radius Application

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_application_connections.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ rad app connections my-application

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application delete Radius CLI command"
---
## rad application delete

Delete Radius application
Delete Radius Application

### Synopsis

Delete the specified Radius application deployed in the default environment
Delete the specified Radius Application deployed in the default environment

```
rad application delete [flags]
Expand Down Expand Up @@ -55,5 +55,5 @@ rad app delete my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application list Radius CLI command"
---
## rad application list

List Radius applications
List Radius Applications

### Synopsis

Lists Radius applications deployed in the resource group associated with the default environment
Lists Radius Applications deployed in the resource group associated with the default environment

```
rad application list [flags]
Expand Down Expand Up @@ -47,5 +47,5 @@ rad app list --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application show Radius CLI command"
---
## rad application show

Show Radius application details
Show Radius Application details

### Synopsis

Show Radius application details. Shows the user's default application (if configured) by default.
Show Radius Application details. Shows the user's default application (if configured) by default.

```
rad application show [flags]
Expand Down Expand Up @@ -51,5 +51,5 @@ rad app show my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_status.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application status Radius CLI command"
---
## rad application status

Show Radius application status
Show Radius Application status

### Synopsis

Show Radius application status, such as public endpoints and resource count. Shows details for the user's default application (if configured) by default.
Show Radius Application status, such as public endpoints and resource count. Shows details for the user's default application (if configured) by default.

```
rad application status [flags]
Expand Down Expand Up @@ -51,5 +51,5 @@ rad app status my-app --group my-group

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_application_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ description: "Details on the rad application switch Radius CLI command"
---
## rad application switch

Switch the default Radius application
Switch the default Radius Application

### Synopsis

Switches the default Radius application
Switches the default Radius Application

```
rad application switch [flags]
Expand Down Expand Up @@ -41,5 +41,5 @@ rad app switch newApplication

### SEE ALSO

* [rad application]({{< ref rad_application.md >}}) - Manage Radius applications
* [rad application]({{< ref rad_application.md >}}) - Manage Radius Applications

4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Manage cloud provider credential for a Radius installation.

Manage cloud provider credential for a Radius installation.

Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

### Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ List configured cloud provider credentials

List configured cloud providers credentials.

Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

```
rad credential list [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential_register.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Register(Add or update) cloud provider credential for a Radius installation.

Register (Add or update) cloud provider configuration for a Radius installation.

Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

### Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential_register_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ to configure these settings.
Radius will use the provided IAM credential for all interactions with AWS.


Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

```
rad credential register aws [flags]
Expand Down
6 changes: 3 additions & 3 deletions docs/content/reference/cli/rad_credential_register_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ 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 portable resources.
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
in order to create or manage resources contained in the group. The resource group should be created before
calling 'rad credential register azure'.


Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

```
rad credential register azure [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Show details of a configured cloud provider credential

Show details of a configured cloud provider credential.

Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

```
rad credential show [name] [flags]
Expand Down
4 changes: 2 additions & 2 deletions docs/content/reference/cli/rad_credential_unregister.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ Unregisters a configured cloud provider credential from the Radius installation

Unregisters a configured cloud provider credential from the Radius installation.

Radius cloud providers enable Radius environments to deploy and integrate with cloud resources (Azure, AWS).
Radius cloud providers enable Radius Environments to deploy and integrate with cloud resources (Azure, AWS).
The Radius control-plane stores credentials for use when accessing cloud resources.

Cloud providers are configured per-Radius-installation. Configuration commands will use the current workspace
or the workspace specified by '--workspace' to configure Radius. Modifications to cloud provider configuration
or credentials will affect all Radius environments and applications of the affected installation.
or credentials will affect all Radius Environments and applications of the affected installation.

```
rad credential unregister [flags]
Expand Down
8 changes: 4 additions & 4 deletions docs/content/reference/cli/rad_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ description: "Details on the rad env Radius CLI command"
---
## rad env

Manage Radius environments
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.
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

Expand All @@ -33,7 +33,7 @@ Radius environments are prepared “landing zones” for Radius applications. Ap
### SEE ALSO

* [rad]({{< ref rad.md >}}) - Radius CLI
* [rad env create]({{< ref rad_env_create.md >}}) - Create a new Radius environment
* [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
Expand Down
8 changes: 4 additions & 4 deletions docs/content/reference/cli/rad_env_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ description: "Details on the rad env create Radius CLI command"
---
## rad env create

Create a new Radius environment
Create a new Radius Environment

### Synopsis

Create a new Radius environment
Radius environments are prepared "landing zones" for Radius applications.
Create a new Radius Environment
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.

```
Expand Down Expand Up @@ -45,5 +45,5 @@ rad env create myenv

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_env_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,5 +55,5 @@ rad env delete my-env --group my-env

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_env_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ rad env list

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_env_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,5 +51,5 @@ rad env show my-env --group my-env

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_env_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ rad env switch newEnvironment

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_env_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,5 @@ rad env update myenv --clear-aws

### SEE ALSO

* [rad env]({{< ref rad_env.md >}}) - Manage Radius environments
* [rad env]({{< ref rad_env.md >}}) - Manage Radius Environments

2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Manage resource groups

Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.

A Radius application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius environment into which it's being deployed into.
A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into.

Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Create a new resource group

Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.

A Radius application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius environment into which it's being deployed into.
A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into.

Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ List resource groups within current/specified workspace

Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.

A Radius application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius environment into which it's being deployed into.
A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into.

Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Show the details of a resource group

Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.

A Radius application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius environment into which it's being deployed into.
A Radius Application and its resources can span one or more resource groups, and do not have to be in the same resource group as the Radius Environment into which it's being deployed into.

Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/cli/rad_group_switch.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Switch default resource group scope

Switch default resource group scope

Radius workspaces contain a resource group scope, where Radius applications and resources are deployed by default. The switch command changes the default scope of the workspace to the specified resource group name.
Radius workspaces contain a resource group scope, where Radius Applications and resources are deployed by default. The switch command changes the default scope of the workspace to the specified resource group name.

Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.

Expand Down

0 comments on commit 230dd04

Please sign in to comment.