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 Nov 12, 2024
1 parent 3b6c23f commit 6e63570
Show file tree
Hide file tree
Showing 11 changed files with 431 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/content/reference/cli/rad.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ Radius CLI
* [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
* [rad resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers
* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types
* [rad run]({{< ref rad_run.md >}}) - Run an application
* [rad uninstall]({{< ref rad_uninstall.md >}}) - Uninstall Radius for a specific platform
* [rad version]({{< ref rad_version.md >}}) - Prints the versions of the rad cli
Expand Down
37 changes: 37 additions & 0 deletions docs/content/reference/cli/rad_resource-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
type: docs
title: "rad resource-provider CLI reference"
linkTitle: "rad resource-provider"
slug: rad_resource-provider
url: /reference/cli/rad_resource-provider/
description: "Details on the rad resource-provider Radius CLI command"
---
## rad resource-provider

Manage resource providers

### Synopsis

Manage resource providers

### Options

```
-h, --help help for resource-provider
-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 resource-provider delete]({{< ref rad_resource-provider_delete.md >}}) - Delete resource provider
* [rad resource-provider list]({{< ref rad_resource-provider_list.md >}}) - List resource providers
* [rad resource-provider show]({{< ref rad_resource-provider_show.md >}}) - Show resource provider

56 changes: 56 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
type: docs
title: "rad resource-provider delete CLI reference"
linkTitle: "rad resource-provider delete"
slug: rad_resource-provider_delete
url: /reference/cli/rad_resource-provider_delete/
description: "Details on the rad resource-provider delete Radius CLI command"
---
## rad resource-provider delete

Delete resource provider

### Synopsis

Delete resource provider

Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users.

Deleting a resource provider will delete all resource types that it defines. For example, deleting 'Applications.Core' will delete 'Applications.Core/containers' and all other resource types defined by 'Applications.Core'.

Deleting a resource type will delete all resources of the types. For example, deleting 'Applications.Core/containers' will delete all containers.

```
rad resource-provider delete [resource provider namespace] [flags]
```

### Examples

```
# Delete a resource provider
rad resource-provider delete Applications.Core
# Delete a resource provider (bypass confirmation)
rad resource-provider delete Applications.Core --yes
```

### Options

```
-h, --help help for delete
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
-y, --yes The confirmation flag
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: docs
title: "rad resource-provider list CLI reference"
linkTitle: "rad resource-provider list"
slug: rad_resource-provider_list
url: /reference/cli/rad_resource-provider_list/
description: "Details on the rad resource-provider list Radius CLI command"
---
## rad resource-provider list

List resource providers

### Synopsis

List resource providers

Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users.

```
rad resource-provider list [flags]
```

### Examples

```
# List all resource providers
rad resource-provider list
```

### Options

```
-h, --help help for list
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-provider_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: docs
title: "rad resource-provider show CLI reference"
linkTitle: "rad resource-provider show"
slug: rad_resource-provider_show
url: /reference/cli/rad_resource-provider_show/
description: "Details on the rad resource-provider show Radius CLI command"
---
## rad resource-provider show

Show resource provider

### Synopsis

Show resource provider

Resource providers are the entities that implement resource types such as 'Applications.Core/containers'. Resource providers can be created and deleted by users.

```
rad resource-provider show [resource provider namespace] [flags]
```

### Examples

```
# Show a resource provider
rad resource-provider show Applications.Core
```

### Options

```
-h, --help help for show
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-provider]({{< ref rad_resource-provider.md >}}) - Manage resource providers

37 changes: 37 additions & 0 deletions docs/content/reference/cli/rad_resource-type.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
type: docs
title: "rad resource-type CLI reference"
linkTitle: "rad resource-type"
slug: rad_resource-type
url: /reference/cli/rad_resource-type/
description: "Details on the rad resource-type Radius CLI command"
---
## rad resource-type

Manage resource types

### Synopsis

Manage resource types

### Options

```
-h, --help help for resource-type
-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 resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource provider
* [rad resource-type list]({{< ref rad_resource-type_list.md >}}) - List resource resource types
* [rad resource-type show]({{< ref rad_resource-type_show.md >}}) - Show resource resource type

54 changes: 54 additions & 0 deletions docs/content/reference/cli/rad_resource-type_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
type: docs
title: "rad resource-type delete CLI reference"
linkTitle: "rad resource-type delete"
slug: rad_resource-type_delete
url: /reference/cli/rad_resource-type_delete/
description: "Details on the rad resource-type delete Radius CLI command"
---
## rad resource-type delete

Delete resource provider

### Synopsis

Delete resource provider

Resource types are the entities that implement resource types such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource providers can be created and deleted by users.

Deleting a resource type will delete all resources of the specifed resource type. For example, deleting 'Applications.Core/containers' will delete all containers.

```
rad resource-type delete [resource type] [flags]
```

### Examples

```
# Delete a resource type
rad resource-type delete Applications.Core/containers
# Delete a resource type (bypass confirmation)
rad resource-type delete Applications.Core/containers --yes
```

### Options

```
-h, --help help for delete
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
-y, --yes The confirmation flag
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-type_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: docs
title: "rad resource-type list CLI reference"
linkTitle: "rad resource-type list"
slug: rad_resource-type_list
url: /reference/cli/rad_resource-type_list/
description: "Details on the rad resource-type list Radius CLI command"
---
## rad resource-type list

List resource resource types

### Synopsis

List resource resource types

Resource types are the entities that can be created and managed by Radius such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource types can be configured using resource providers.

```
rad resource-type list [flags]
```

### Examples

```
# List all resource types
rad resource-type list
```

### Options

```
-h, --help help for list
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types

48 changes: 48 additions & 0 deletions docs/content/reference/cli/rad_resource-type_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
type: docs
title: "rad resource-type show CLI reference"
linkTitle: "rad resource-type show"
slug: rad_resource-type_show
url: /reference/cli/rad_resource-type_show/
description: "Details on the rad resource-type show Radius CLI command"
---
## rad resource-type show

Show resource resource type

### Synopsis

Show resource resource type

Resource types are the entities that can be created and managed by Radius such as 'Applications.Core/containers'. Each resource type can define multiple API versions, and each API version defines a schema that resource instances conform to. Resource types can be configured using resource providers.

```
rad resource-type show [resource type] [flags]
```

### Examples

```
# Show a resource type
rad resource-type show 'Applications.Core/containers'
```

### Options

```
-h, --help help for show
-o, --output string output format (supported formats are json, table) (default "table")
-w, --workspace string The workspace name
```

### Options inherited from parent commands

```
--config string config file (default "$HOME/.rad/config.yaml")
```

### SEE ALSO

* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types

Loading

0 comments on commit 6e63570

Please sign in to comment.