Skip to content

Commit

Permalink
Doc formatting for rad_group_switch synopsis text (#7962)
Browse files Browse the repository at this point in the history
Fix the synopsis text formatting from a code block to a regular text
block.

- [x] [Read the contribution
guide](https://docs.radapp.io/community/contributing/docs/)
- [x] Commands include options for Linux, MacOS, and Windows within
codetabs
- [x] New file and folder names are globally unique
- [x] Page references use shortcodes instead of markdown or URL links
- [x] Images use HTML style and have alternative text
- [x] Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand
this pull request:

## Description

The rad [group switch
page](https://docs.radapp.io/reference/cli/rad_group_switch/) currently
uses code formatting for the synopsis text. This PR fixes the
formatting.


![image](https://github.com/user-attachments/assets/5f456e77-0304-4368-a72c-06256ddc3ab8)


## Issue reference

Fixes: N/A

## Other
@Reshrahim thank you for reviewing the other PR on this and pointing me
to the right way to fix:
radius-project/docs#1206

---------

Signed-off-by: Brooke Hamilton <[email protected]>
Co-authored-by: Ryan Nowak <[email protected]>
Co-authored-by: Yetkin Timocin <[email protected]>
  • Loading branch information
3 people authored Nov 13, 2024
1 parent 1cb666c commit 125b9fd
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 52 deletions.
34 changes: 17 additions & 17 deletions pkg/cli/cmd/deploy/deploy.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,24 +53,24 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Deploy a template",
Long: `Deploy a Bicep or ARM template
The deploy command compiles a Bicep or ARM template and deploys it to your default environment (unless otherwise specified).
You can combine Radius types as as well as other types that are available in Bicep such as Azure resources. See
the Radius documentation for information about describing your application and resources with Bicep.
The deploy command compiles a Bicep or ARM template and deploys it to your default environment (unless otherwise specified).
You can specify parameters using the '--parameter' flag ('-p' for short). Parameters can be passed as:
- A file containing multiple parameters using the ARM JSON parameter format (see below)
- A file containing a single value in JSON format
- A key-value-pair passed in the command line
When passing multiple parameters in a single file, use the format described here:
https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/parameter-files
You can specify parameters using multiple sources. Parameters can be overridden based on the
order the are provided. Parameters appearing later in the argument list will override those defined earlier.
`,
You can combine Radius types as as well as other types that are available in Bicep such as Azure resources. See
the Radius documentation for information about describing your application and resources with Bicep.
You can specify parameters using the '--parameter' flag ('-p' for short). Parameters can be passed as:
- A file containing multiple parameters using the ARM JSON parameter format (see below)
- A file containing a single value in JSON format
- A key-value-pair passed in the command line
When passing multiple parameters in a single file, use the format described here:
https://docs.microsoft.com/en-us/azure/azure-resource-manager/templates/parameter-files
You can specify parameters using multiple sources. Parameters can be overridden based on the
order the are provided. Parameters appearing later in the argument list will override those defined earlier.
`,
Example: `
# deploy a Bicep template
rad deploy myapp.bicep
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/cmd/group/delete/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Delete a resource group",
Long: `Delete a resource group.
Delete a resource group if it is empty. If not empty, delete the contents and try again`,
Delete a resource group if it is empty. If not empty, delete the contents and try again`,
Example: `rad group delete rgprod`,
Args: cobra.MaximumNArgs(1),
RunE: framework.RunCommand(runner),
Expand Down
10 changes: 5 additions & 5 deletions pkg/cli/cmd/group/groupswitch/switch.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Switch default resource group scope",
Long: `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.
Resource groups are used to organize and manage Radius resources. They often contain resources that share a common lifecycle or unit of deployment.
Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.`,
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.
Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.`,
Example: `rad group switch rgprod -w wsprod`,
Args: cobra.MaximumNArgs(1),
RunE: framework.RunCommand(runner),
Expand Down
10 changes: 5 additions & 5 deletions pkg/cli/cmd/group/list/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "List resource groups within current/specified workspace",
Long: `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.
Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.`,
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.
Note that these resource groups are separate from the Azure cloud provider and Azure resource groups configured with the cloud provider.`,
Example: `rad group list`,
Args: cobra.ExactArgs(0),
RunE: framework.RunCommand(runner),
Expand Down
8 changes: 4 additions & 4 deletions pkg/cli/cmd/resource/delete/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Delete a Radius resource",
Long: "Deletes a Radius resource with the given name",
Example: `
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
# Delete a container named orders
rad resource delete containers orders`,
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
# Delete a container named orders
rad resource delete containers orders`,
Args: cobra.ExactArgs(2),
RunE: framework.RunCommand(runner),
}
Expand Down
20 changes: 10 additions & 10 deletions pkg/cli/cmd/resource/list/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,19 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Lists resources",
Long: "List all resources of specified type",
Example: `
sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores
sample list of resourceType: containers, gateways, pubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, stateStores, secretStores
# list all resources of a specified type in the default environment
# list all resources of a specified type in the default environment
rad resource list containers
rad resource list gateways
rad resource list containers
rad resource list gateways
# list all resources of a specified type in an application
rad resource list containers --application icecream-store
# list all resources of a specified type in an application (shorthand flag)
rad resource list containers -a icecream-store
`,
# list all resources of a specified type in an application
rad resource list containers --application icecream-store
# list all resources of a specified type in an application (shorthand flag)
rad resource list containers -a icecream-store
`,
Args: cobra.ExactArgs(1),
RunE: framework.RunCommand(runner),
}
Expand Down
20 changes: 10 additions & 10 deletions pkg/cli/cmd/resource/show/show.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,19 +43,19 @@ func NewCommand(factory framework.Factory) (*cobra.Command, framework.Runner) {
Short: "Show Radius resource details",
Long: "Show details of the specified Radius resource",
Example: `
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
sample list of resourceType: containers, gateways, daprPubSubBrokers, extenders, mongoDatabases, rabbitMQMessageQueues, redisCaches, sqlDatabases, daprStateStores, daprSecretStores
# show details of a specified resource in the default environment
# show details of a specified resource in the default environment
rad resource show containers orders
rad resource show gateways orders_gateways
rad resource show containers orders
rad resource show gateways orders_gateways
# show details of a specified resource in an application
rad resource show containers orders --application icecream-store
# show details of a specified resource in an application (shorthand flag)
rad resource show containers orders -a icecream-store
`,
# show details of a specified resource in an application
rad resource show containers orders --application icecream-store
# show details of a specified resource in an application (shorthand flag)
rad resource show containers orders -a icecream-store
`,
Args: cobra.ExactArgs(2),
RunE: framework.RunCommand(runner),
}
Expand Down

0 comments on commit 125b9fd

Please sign in to comment.