Skip to content

Commit 6ed6d23

Browse files
rad-ci-botvishwahiremat
rad-ci-bot
and
vishwahiremat
authored
Update auto-generated documentation (#1591)
* Autogenerate reference docs Signed-off-by: rad-ci-bot <[email protected]> * fixing spellcheck Signed-off-by: Vishwanath Hiremath <[email protected]> --------- Signed-off-by: rad-ci-bot <[email protected]> Signed-off-by: Vishwanath Hiremath <[email protected]> Co-authored-by: rad-ci-bot <[email protected]> Co-authored-by: Vishwanath Hiremath <[email protected]>
1 parent 61bcf76 commit 6ed6d23

File tree

15 files changed

+579
-27
lines changed

15 files changed

+579
-27
lines changed

‎.github/config/en-custom.txt‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1338,4 +1338,16 @@ IDPs
13381338
swappable
13391339
enums
13401340
camelCase
1341-
ArgoCD
1341+
ArgoCD
1342+
recipePacks
1343+
ProvidersKubernetes
1344+
subscriptionId
1345+
ProvidersKubernetes
1346+
recipepacks
1347+
RecipePackProperties
1348+
RecipePackPropertiesRecipes
1349+
referencedBy
1350+
RecipeDefinition
1351+
RecipeDefinitionParameters
1352+
recipeKind
1353+
recipeLocation

‎docs/content/reference/cli/rad.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Radius CLI
3535
* [rad initialize]({{< ref rad_initialize.md >}}) - Initialize Radius
3636
* [rad install]({{< ref rad_install.md >}}) - Installs Radius for a given platform
3737
* [rad recipe]({{< ref rad_recipe.md >}}) - Manage recipes
38+
* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs
3839
* [rad resource]({{< ref rad_resource.md >}}) - Manage resources
3940
* [rad resource-type]({{< ref rad_resource-type.md >}}) - Manage resource types
4041
* [rad rollback]({{< ref rad_rollback.md >}}) - Rolls back Radius for a given platform

‎docs/content/reference/cli/rad_recipe-pack.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
type: docs
3+
title: "rad recipe-pack CLI reference"
4+
linkTitle: "rad recipe-pack"
5+
slug: rad_recipe-pack
6+
url: /reference/cli/rad_recipe-pack/
7+
description: "Details on the rad recipe-pack Radius CLI command"
8+
---
9+
## rad recipe-pack
10+
11+
Manage recipe-packs
12+
13+
### Synopsis
14+
15+
Manage recipe-packs
16+
Recipe-packs automate the deployment of infrastructure and configuration of radius resources.
17+
18+
### Options
19+
20+
```
21+
-h, --help help for recipe-pack
22+
-w, --workspace string The workspace name
23+
```
24+
25+
### Options inherited from parent commands
26+
27+
```
28+
--config string config file (default "$HOME/.rad/config.yaml")
29+
-o, --output string output format (supported formats are json, table) (default "table")
30+
```
31+
32+
### SEE ALSO
33+
34+
* [rad]({{< ref rad.md >}}) - Radius CLI
35+
* [rad recipe-pack delete]({{< ref rad_recipe-pack_delete.md >}}) - Delete recipe pack
36+
* [rad recipe-pack list]({{< ref rad_recipe-pack_list.md >}}) - List recipe packs
37+
* [rad recipe-pack show]({{< ref rad_recipe-pack_show.md >}}) - Show recipe pack details
38+

‎docs/content/reference/cli/rad_recipe-pack_delete.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
type: docs
3+
title: "rad recipe-pack delete CLI reference"
4+
linkTitle: "rad recipe-pack delete"
5+
slug: rad_recipe-pack_delete
6+
url: /reference/cli/rad_recipe-pack_delete/
7+
description: "Details on the rad recipe-pack delete Radius CLI command"
8+
---
9+
## rad recipe-pack delete
10+
11+
Delete recipe pack
12+
13+
### Synopsis
14+
15+
Delete a recipe pack from the current workspace scope.
16+
17+
```
18+
rad recipe-pack delete [flags]
19+
```
20+
21+
### Examples
22+
23+
```
24+
25+
# Delete specified recipe pack
26+
rad recipe-pack delete my-recipe-pack
27+
28+
# Delete recipe pack in a specified resource group
29+
rad recipe-pack delete my-recipe-pack --group my-group
30+
31+
# Delete recipe pack and bypass confirmation prompt
32+
rad recipe-pack delete my-recipe-pack --yes
33+
34+
```
35+
36+
### Options
37+
38+
```
39+
-g, --group string The resource group name
40+
-h, --help help for delete
41+
-w, --workspace string The workspace name
42+
-y, --yes The confirmation flag
43+
```
44+
45+
### Options inherited from parent commands
46+
47+
```
48+
--config string config file (default "$HOME/.rad/config.yaml")
49+
-o, --output string output format (supported formats are json, table) (default "table")
50+
```
51+
52+
### SEE ALSO
53+
54+
* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs
55+

‎docs/content/reference/cli/rad_recipe-pack_list.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
type: docs
3+
title: "rad recipe-pack list CLI reference"
4+
linkTitle: "rad recipe-pack list"
5+
slug: rad_recipe-pack_list
6+
url: /reference/cli/rad_recipe-pack_list/
7+
description: "Details on the rad recipe-pack list Radius CLI command"
8+
---
9+
## rad recipe-pack list
10+
11+
List recipe packs
12+
13+
### Synopsis
14+
15+
Lists all recipe packs in all scopes
16+
17+
```
18+
rad recipe-pack list [flags]
19+
```
20+
21+
### Examples
22+
23+
```
24+
rad recipe-packs list
25+
```
26+
27+
### Options
28+
29+
```
30+
-g, --group string The resource group name
31+
-h, --help help for list
32+
-o, --output string output format (supported formats are json, table) (default "table")
33+
-w, --workspace string The workspace name
34+
```
35+
36+
### Options inherited from parent commands
37+
38+
```
39+
--config string config file (default "$HOME/.rad/config.yaml")
40+
```
41+
42+
### SEE ALSO
43+
44+
* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs
45+

‎docs/content/reference/cli/rad_recipe-pack_show.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
type: docs
3+
title: "rad recipe-pack show CLI reference"
4+
linkTitle: "rad recipe-pack show"
5+
slug: rad_recipe-pack_show
6+
url: /reference/cli/rad_recipe-pack_show/
7+
description: "Details on the rad recipe-pack show Radius CLI command"
8+
---
9+
## rad recipe-pack show
10+
11+
Show recipe pack details
12+
13+
### Synopsis
14+
15+
Show recipe pack details
16+
17+
```
18+
rad recipe-pack show [flags]
19+
```
20+
21+
### Examples
22+
23+
```
24+
25+
26+
# Show specified recipe pack
27+
rad recipe-show show my-recipe-pack
28+
29+
# Show specified recipe pack in a specified resource group
30+
rad recipe-show show my-recipe-pack --group my-group
31+
32+
```
33+
34+
### Options
35+
36+
```
37+
-g, --group string The resource group name
38+
-h, --help help for show
39+
-o, --output string output format (supported formats are plain-text, json) (default "plain-text")
40+
-w, --workspace string The workspace name
41+
```
42+
43+
### Options inherited from parent commands
44+
45+
```
46+
--config string config file (default "$HOME/.rad/config.yaml")
47+
```
48+
49+
### SEE ALSO
50+
51+
* [rad recipe-pack]({{< ref rad_recipe-pack.md >}}) - Manage recipe-packs
52+

‎docs/content/reference/cli/rad_resource-type.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Manage resource types
3232

3333
* [rad]({{< ref rad.md >}}) - Radius CLI
3434
* [rad resource-type create]({{< ref rad_resource-type_create.md >}}) - Create or update a resource type
35-
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete resource type
35+
* [rad resource-type delete]({{< ref rad_resource-type_delete.md >}}) - Delete a resource type
3636
* [rad resource-type list]({{< ref rad_resource-type_list.md >}}) - List resource resource types
3737
* [rad resource-type show]({{< ref rad_resource-type_show.md >}}) - Show resource resource type
3838

‎docs/content/reference/cli/rad_resource-type_create.md‎

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,35 @@ Create or update a resource type
1212

1313
### Synopsis
1414

15-
Create or update a resource type from a resource type manifest.
16-
17-
Resource types are user defined types such as 'Mycompany.Messaging/plaid'.
18-
19-
Creating a resource type defines a new type that can be used in applications.
20-
21-
Input can be passed in using a JSON or YAML file using the --from-file option.
22-
23-
resource-type name argument is optional. If specified, only the specified type is created/updated.
24-
If not specified, all resource types in the referenced file are created/updated.
25-
15+
Create or update a resource type from a resource type definition file.
16+
17+
Resource types define the resources that Radius can deploy and the API for those resources. They are defined by a name, one or more API versions, and an OpenAPI schema.
18+
19+
Input can be passed in using a JSON or YAML file using the --from-file option.
20+
21+
The resource type name argument is optional. If specified, only the specified type is created/updated. If not specified, all resource types in the referenced file are created/updated.
22+
23+
The resource type name argument is the simple name (e.g., 'testResources') not the fully qualified name.
24+
2625

2726
```
28-
rad resource-type create [input] [flags]
27+
rad resource-type create [resource-type-name] [flags]
2928
```
3029

3130
### Examples
3231

3332
```
3433
35-
# Create a resource type from YAML file
34+
# Create a specific resource type from a YAML file
3635
rad resource-type create myType --from-file /path/to/input.yaml
3736
38-
# Create a resource type from JSON file
37+
# Create a specific resource type from a JSON file
3938
rad resource-type create myType --from-file /path/to/input.json
4039
41-
# Create all resource types from YAML file
42-
rad resource-type create --from-file /path/to/input.yaml
40+
# Create all resource types from a YAML file
41+
rad resource-type create --from-file /path/to/input.yaml
4342
44-
# Create all resource types from JSON file
43+
# Create all resource types from a JSON file
4544
rad resource-type create --from-file /path/to/input.json
4645
4746
```

‎docs/content/reference/cli/rad_resource-type_delete.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,27 @@ description: "Details on the rad resource-type delete Radius CLI command"
88
---
99
## rad resource-type delete
1010

11-
Delete resource type
11+
Delete a resource type
1212

1313
### Synopsis
1414

15-
Delete resource type
16-
17-
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.
15+
Delete a resource type
16+
17+
Deleting a resource type will delete the specified resource type. For example, deleting 'Applications.Core/containers' will delete that type (but not deployed instances of the type).
18+
19+
The resource type name argument must be a fully qualified resource type name in the format 'ResourceType.Namespace/resourceTypeName' (e.g., 'Radius.Compute/containers').
1820

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

2122
```
22-
rad resource-type delete [resource type] [flags]
23+
rad resource-type delete [resource-type-name] [flags]
2324
```
2425

2526
### Examples
2627

2728
```
2829
29-
# Delete a resource type
30-
rad resource-type delete Applications.Core/containers
30+
# Delete a resource type (fully qualified name required)
31+
rad resource-type delete Radius.Compute/containers
3132
3233
# Delete a resource type (bypass confirmation)
3334
rad resource-type delete Applications.Core/containers --yes

‎docs/content/reference/resources/radius/_index.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
type: docs
3+
title: "Reference: radius"
4+
linkTitle: "radius"
5+
description: "Detailed reference documentation for radius"
6+
---
7+

0 commit comments

Comments
 (0)