Skip to content

Commit

Permalink
Autogenerate reference docs
Browse files Browse the repository at this point in the history
Signed-off-by: rad-ci-bot <[email protected]>
  • Loading branch information
rad-ci-bot committed Dec 12, 2024
1 parent f475b84 commit cbc4a75
Show file tree
Hide file tree
Showing 12 changed files with 105 additions and 103 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 @@ -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
Expand Down
1 change: 0 additions & 1 deletion docs/content/reference/cli/rad_application_graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
42 changes: 0 additions & 42 deletions docs/content/reference/cli/rad_env.md

This file was deleted.

42 changes: 42 additions & 0 deletions docs/content/reference/cli/rad_environment.md
Original file line number Diff line number Diff line change
@@ -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

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down 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 environment]({{< ref rad_environment.md >}}) - Manage Radius Environments

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -15,7 +15,7 @@ List environments
List environments using the current, or specified workspace.

```
rad env list [flags]
rad environment list [flags]
```

### Examples
Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down 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 environment]({{< ref rad_environment.md >}}) - Manage Radius Environments

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -15,7 +15,7 @@ Switch the current environment
Switch the current environment

```
rad env switch [environment] [flags]
rad environment switch [environment] [flags]
```

### Examples
Expand All @@ -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

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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

Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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")
```

Expand Down
7 changes: 5 additions & 2 deletions docs/content/reference/cli/rad_resource-provider_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


```
Expand All @@ -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
Expand Down

0 comments on commit cbc4a75

Please sign in to comment.