-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create rad overview page * Move rad CLI pages * Move VSCode section * Spellcheck * Apply suggestions from code review Co-authored-by: Jonathan Smith <[email protected]> Co-authored-by: Reshma Abdul Rahim <[email protected]> --------- Co-authored-by: Jonathan Smith <[email protected]> Co-authored-by: Reshma Abdul Rahim <[email protected]>
- Loading branch information
1 parent
1e51011
commit 3e83e1b
Showing
14 changed files
with
155 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
type: docs | ||
title: "Radius Tooling" | ||
linkTitle: "Tooling" | ||
description: "Learn about Radius tools for managing your applications and Radius installation" | ||
weight: 99 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
type: docs | ||
title: "rad CLI" | ||
linkTitle: "rad CLI" | ||
description: "Documentation on the rad CLI" | ||
weight: 100 | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
--- | ||
type: docs | ||
title: "Overview: rad CLI" | ||
linkTitle: "Overview" | ||
description: "Learn about the rad CLI and how to interact with Radius from your local machine" | ||
weight: 100 | ||
categories: "Overview" | ||
tags: ["rad CLI"] | ||
--- | ||
|
||
The rad Command Line Interface (CLI) allows you to interact with Radius from your local machine. It is the primary way to interact with Radius and is used to create, deploy, and manage your applications, environments, and resources. | ||
|
||
```bash | ||
$ rad | ||
Radius CLI | ||
|
||
Usage: | ||
rad [command] | ||
|
||
Available Commands: | ||
application Manage Radius applications | ||
bicep Manage bicep compiler | ||
completion Generates shell completion scripts | ||
credential Manage cloud provider credential for a Radius installation. | ||
debug-logs Capture logs from Radius control plane for debugging and diagnostics. | ||
deploy Deploy a template | ||
env Manage Radius environments | ||
group Manage resource groups | ||
help Help about any command | ||
init Initialize Radius | ||
install Installs Radius for a given platform | ||
recipe Manage recipes | ||
resource Manage resources | ||
run Run an application | ||
uninstall Uninstall Radius for a specific platform | ||
version Prints the versions of the rad cli | ||
workspace Manage workspaces | ||
``` | ||
|
||
## Installation | ||
|
||
The rad CLI is distributed as a single binary that can be installed on Linux, macOS, and Windows. Visit the [installation guide]({{< ref howto-rad-cli >}}) to learn how to install the rad CLI. | ||
|
||
{{< button text="Install rad CLI" page="howto-rad-cli" >}} | ||
|
||
### Binary location | ||
|
||
{{< tabs "macOS/Linux/WSL" "Windows" >}} | ||
|
||
{{% codetab %}} | ||
By default, the rad CLI installation script installs the rad CLI to `/usr/local/bin/rad` | ||
|
||
If you would like to install the rad CLI to a different path, you can specify the path with the `RADIUS_INSTALL_DIR` environment variable: | ||
|
||
```bash | ||
# Install to home directory | ||
export RADIUS_INSTALL_DIR=~/ | ||
``` | ||
|
||
{{% /codetab %}} | ||
|
||
{{% codetab %}} | ||
By default, the rad CLI installation script installs the rad CLI to `%LOCALAPPDATA%\radius\rad.exe` | ||
|
||
{{% /codetab %}} | ||
|
||
{{< /tabs >}} | ||
|
||
### Configuration location | ||
|
||
The rad CLI stores workspaces, the rad-Bicep compiler, and other configuration under the `rad` directory. | ||
|
||
{{< tabs "macOS/Linux/WSL" "Windows" >}} | ||
|
||
{{% codetab %}} | ||
The rad CLI stores configuration under `~/.rad` | ||
{{% /codetab %}} | ||
|
||
{{% codetab %}} | ||
The rad CLI stores configuration under `%USERPROFILE%\rad` | ||
{{% /codetab %}} | ||
|
||
{{< /tabs >}} | ||
|
||
|
||
## Reference documentation | ||
|
||
Visit the [reference documentation]({{< ref "/reference/cli" >}}) to learn more about the rad CLI and its commands. | ||
|
||
{{< button text="Reference docs" page="/reference/cli" >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
type: docs | ||
title: "Visual Studio Code tooling" | ||
linkTitle: "VS Code" | ||
description: "Learn how to use Radius in Visual Studio Code" | ||
weight: 200 | ||
categories: "How-To" | ||
tags: ["VSCode"] | ||
--- |
4 changes: 2 additions & 2 deletions
4
.../guides/author-apps/howto-vscode/index.md → ...ooling/vscode/howto-vscode-bicep/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
type: docs | ||
title: "Overview: Using Radius in Visual Studio Code" | ||
linkTitle: "Overview" | ||
description: "Learn how to use Radius in Visual Studio Code" | ||
weight: 100 | ||
categories: "Overview" | ||
tags: ["VSCode"] | ||
--- | ||
|
||
When using Visual Studio Code with Radius there are a set of extensions you can install to help author, validate, and manage your Radius applications and environments. | ||
|
||
## Radius Bicep extension | ||
|
||
The Radius Bicep extension provides formatting, intellisense, and validation for Bicep templates. | ||
|
||
<img src="vscode-bicep.png" alt="Screenshot of the Radius Bicep extension showing available Radius resource types" width=600px > | ||
<br /><br/> | ||
|
||
{{< button text="Radius Bicep guide" page="howto-vscode-bicep" >}} | ||
|
||
{{< alert title="Note" color="secondary" >}} | ||
The Radius Bicep extension is a temporary extension that exists to model Radius and AWS resource types. Radius Bicep extension will be deprecated once we upstream our extensibility updates to the official Bicep. Stay tuned for updates. | ||
|
||
**The Radius Bicep extension is not compatible with the official Bicep extension.** If you have the official Bicep extension installed you will need to disable or uninstall it before installing the Radius Bicep extension. | ||
{{< /alert >}} | ||
|
||
## Terraform extension | ||
|
||
When authoring [Terraform Recipes]({{< ref "/guides/recipes/overview" >}}) you can use the HashiCorp Terraform extension to help author, validate, and manage your Terraform templates. | ||
|
||
{{< button text="Terraform extension" link="https://marketplace.visualstudio.com/items?itemName=hashicorp.terraform" newtab="true" >}} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters