diff --git a/.github/config/en-custom.txt b/.github/config/en-custom.txt index 381d9d419..e7563ffda 100644 --- a/.github/config/en-custom.txt +++ b/.github/config/en-custom.txt @@ -86,8 +86,6 @@ PowerShell Pre PubSub ProjectRadius -Quickstart -Quickstarts RBAC RabbitMQ ResourceDeploymentClient @@ -291,8 +289,6 @@ publickey publicEndpointOverride pubsub px -quickstart -quickstarts rabbitMQMessageQueues rabbitmq radapp @@ -437,6 +433,8 @@ hl azureCache listKeys primaryKey +quickstart +quickstarts mygroup Kubeconfig unregister @@ -449,4 +447,4 @@ untyped authSource mongodb MYCONNECTION -VHOST \ No newline at end of file +VHOST diff --git a/docs/content/author-apps/container/_index.md b/docs/content/author-apps/container/_index.md new file mode 100644 index 000000000..3d60c8e05 --- /dev/null +++ b/docs/content/author-apps/container/_index.md @@ -0,0 +1,9 @@ +--- +type: docs +title: "Containerized workloads" +linkTitle: "Containers" +description: "Model and run container workloads in your Radius application" +weight: 300 +categories: "Overview" +tags: ["containers"] +--- diff --git a/docs/content/author-apps/container/index.md b/docs/content/author-apps/container/container-overview.md similarity index 97% rename from docs/content/author-apps/container/index.md rename to docs/content/author-apps/container/container-overview.md index d1e0456d9..64fffe463 100644 --- a/docs/content/author-apps/container/index.md +++ b/docs/content/author-apps/container/container-overview.md @@ -1,9 +1,9 @@ --- type: docs -title: "Containerized workloads" -linkTitle: "Containers" -description: "Model and run container workloads in your Radius application" -weight: 300 +title: "Overview: Radius containers" +linkTitle: "Overview" +description: "Learn how to model and run container workloads in your Radius application" +weight: 100 categories: "Overview" tags: ["containers"] --- @@ -109,5 +109,4 @@ The `daprSidecar` extensions adds and configures a [Dapr](https://dapr.io) sidec ## Further reading -{{< categorizeby category="Quickstart" tag="containers" >}} {{< categorizeby category="How-To" tag="containers" >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/icon.png b/docs/content/author-apps/container/howto-environment-variables/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/icon.png rename to docs/content/author-apps/container/howto-environment-variables/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md b/docs/content/author-apps/container/howto-environment-variables/index.md similarity index 94% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md rename to docs/content/author-apps/container/howto-environment-variables/index.md index 57a11e344..4f0138b32 100644 --- a/docs/content/getting-started/quickstarts/quickstart-environment-variables/index.md +++ b/docs/content/author-apps/container/howto-environment-variables/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Environment Variables" -linkTitle: "Environment variables" +title: "How-To: Set environment variables on a container" +linkTitle: "How-To: Env vars" description: "Learn how to set environment variables manually and through connections" -weight: 100 +weight: 200 slug: "environment-variables" -categories: "Quickstart" +categories: "How-To" tags: ["containers"] --- -This quickstart will teach you: +This how-to guide will teach you: 1. How to set environment variables manually 1. How to set environment variables through connections diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot-all.jpg b/docs/content/author-apps/container/howto-environment-variables/screenshot-all.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot-all.jpg rename to docs/content/author-apps/container/howto-environment-variables/screenshot-all.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot.jpg b/docs/content/author-apps/container/howto-environment-variables/screenshot.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/screenshot.jpg rename to docs/content/author-apps/container/howto-environment-variables/screenshot.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/1-app.bicep b/docs/content/author-apps/container/howto-environment-variables/snippets/1-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/1-app.bicep rename to docs/content/author-apps/container/howto-environment-variables/snippets/1-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/2-app.bicep b/docs/content/author-apps/container/howto-environment-variables/snippets/2-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/2-app.bicep rename to docs/content/author-apps/container/howto-environment-variables/snippets/2-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/3-app.bicep b/docs/content/author-apps/container/howto-environment-variables/snippets/3-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-environment-variables/snippets/3-app.bicep rename to docs/content/author-apps/container/howto-environment-variables/snippets/3-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/icon.png b/docs/content/author-apps/container/howto-keyvault-volume/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/icon.png rename to docs/content/author-apps/container/howto-keyvault-volume/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md b/docs/content/author-apps/container/howto-keyvault-volume/index.md similarity index 93% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md rename to docs/content/author-apps/container/howto-keyvault-volume/index.md index 2da0bc9c5..a66f4d37f 100644 --- a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/index.md +++ b/docs/content/author-apps/container/howto-keyvault-volume/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Mount an Azure Key Vault as a volume to a container" -linkTitle: "Persistent Key Vault volume" +title: "How-To: Mount an Azure Key Vault as a volume to a container" +linkTitle: "How-To: Mount a Key Vault" description: "Learn how to mount an Azure Key Vault as a volume to a container" -weight: 700 +weight: 400 slug: 'volume-keyvault' -categories: "Quickstart" +categories: "How-To" tags: ["Azure","containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Setup a Radius environment with an identity provider - Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments diff --git a/docs/content/getting-started/quickstarts/quickstart-keyvault-wi/snippets/keyvault-wi.bicep b/docs/content/author-apps/container/howto-keyvault-volume/snippets/keyvault-wi.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-keyvault-wi/snippets/keyvault-wi.bicep rename to docs/content/author-apps/container/howto-keyvault-volume/snippets/keyvault-wi.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/icon.png b/docs/content/author-apps/container/howto-volumes/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/icon.png rename to docs/content/author-apps/container/howto-volumes/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/index.md b/docs/content/author-apps/container/howto-volumes/index.md similarity index 93% rename from docs/content/getting-started/quickstarts/quickstart-volumes/index.md rename to docs/content/author-apps/container/howto-volumes/index.md index d442808f5..46b0e3a60 100644 --- a/docs/content/getting-started/quickstarts/quickstart-volumes/index.md +++ b/docs/content/author-apps/container/howto-volumes/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Mount a volume to a container" -linkTitle: "Volume mounts" +title: "How-To: Mount a volume to a container" +linkTitle: "How-To: Volumes" description: "Learn how to mount a volume to a container" -weight: 200 +weight: 300 slug: 'volumes' -categories: "Quickstart" +categories: "How-To" tags: ["containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Mount an ephemeral (short-lived) volume to a container diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-empty.jpg b/docs/content/author-apps/container/howto-volumes/screenshot-empty.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-empty.jpg rename to docs/content/author-apps/container/howto-volumes/screenshot-empty.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-error.jpg b/docs/content/author-apps/container/howto-volumes/screenshot-error.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot-error.jpg rename to docs/content/author-apps/container/howto-volumes/screenshot-error.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/screenshot.jpg b/docs/content/author-apps/container/howto-volumes/screenshot.jpg similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/screenshot.jpg rename to docs/content/author-apps/container/howto-volumes/screenshot.jpg diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/snippets/1-app.bicep b/docs/content/author-apps/container/howto-volumes/snippets/1-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/snippets/1-app.bicep rename to docs/content/author-apps/container/howto-volumes/snippets/1-app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-volumes/snippets/2-app.bicep b/docs/content/author-apps/container/howto-volumes/snippets/2-app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-volumes/snippets/2-app.bicep rename to docs/content/author-apps/container/howto-volumes/snippets/2-app.bicep diff --git a/docs/content/author-apps/platform-resources/aws/index.md b/docs/content/author-apps/platform-resources/aws/index.md index b2b6ccf67..37da1fcc2 100644 --- a/docs/content/author-apps/platform-resources/aws/index.md +++ b/docs/content/author-apps/platform-resources/aws/index.md @@ -1,9 +1,9 @@ --- type: docs title: "AWS resources" -linkTitle: "AWS" +linkTitle: "Overview: AWS" description: "Deploy and connect to AWS resources in your application" -weight: 900 +weight: 100 categories: "Overview" tags: ["AWS"] --- diff --git a/docs/content/author-apps/platform-resources/azure/index.md b/docs/content/author-apps/platform-resources/azure/index.md index 85ec9667a..95cd8981d 100644 --- a/docs/content/author-apps/platform-resources/azure/index.md +++ b/docs/content/author-apps/platform-resources/azure/index.md @@ -1,9 +1,9 @@ --- type: docs title: "Microsoft Azure resources" -linkTitle: "Microsoft Azure" +linkTitle: "Overview: Azure" description: "Deploy and connect to Azure resources in your application" -weight: 800 +weight: 500 categories: "Overview" tags: ["Azure"] --- diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md b/docs/content/author-apps/platform-resources/howto-aws-resources/_index.md similarity index 97% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md rename to docs/content/author-apps/platform-resources/howto-aws-resources/_index.md index 6bcb73dea..a488a2de7 100644 --- a/docs/content/getting-started/quickstarts/quickstart-aws-s3/_index.md +++ b/docs/content/author-apps/platform-resources/howto-aws-resources/_index.md @@ -1,14 +1,14 @@ --- type: docs -title: "Quickstart: Deploy AWS resources" -linkTitle: "Deploy AWS resources" +title: "How-To: Deploy AWS resources" +linkTitle: "How-To: Use AWS resources" description: "Learn about how to add AWS resources to your application and deploy them with Radius" -categories: "Quickstart" +categories: "How-To" tags: ["AWS"] - +weight: 200 --- -This quickstart will show you: +This how-to guide will show you: - How to model an AWS S3 resource in Bicep - How to use a sample application to interact with AWS S3 bucket diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/icon.png b/docs/content/author-apps/platform-resources/howto-aws-resources/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/icon.png rename to docs/content/author-apps/platform-resources/howto-aws-resources/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/s3app.png b/docs/content/author-apps/platform-resources/howto-aws-resources/s3app.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/s3app.png rename to docs/content/author-apps/platform-resources/howto-aws-resources/s3app.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/s3appdiagram.png b/docs/content/author-apps/platform-resources/howto-aws-resources/s3appdiagram.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/s3appdiagram.png rename to docs/content/author-apps/platform-resources/howto-aws-resources/s3appdiagram.png diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/app.bicep b/docs/content/author-apps/platform-resources/howto-aws-resources/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/app.bicep rename to docs/content/author-apps/platform-resources/howto-aws-resources/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3.bicep b/docs/content/author-apps/platform-resources/howto-aws-resources/snippets/s3.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3.bicep rename to docs/content/author-apps/platform-resources/howto-aws-resources/snippets/s3.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3app.bicep b/docs/content/author-apps/platform-resources/howto-aws-resources/snippets/s3app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-aws-s3/snippets/s3app.bicep rename to docs/content/author-apps/platform-resources/howto-aws-resources/snippets/s3app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/icon.png b/docs/content/author-apps/platform-resources/howto-azure-resources/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/icon.png rename to docs/content/author-apps/platform-resources/howto-azure-resources/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/index.md b/docs/content/author-apps/platform-resources/howto-azure-resources/index.md similarity index 94% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/index.md rename to docs/content/author-apps/platform-resources/howto-azure-resources/index.md index 3eaadafa1..2e3f372bd 100644 --- a/docs/content/getting-started/quickstarts/quickstart-container-wi/index.md +++ b/docs/content/author-apps/platform-resources/howto-azure-resources/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Connect a container to an Azure resource" -linkTitle: "Connect to Azure resources" +title: "How-To: Connect a container to an Azure resource" +linkTitle: "How-To: Use Azure resources" description: "Learn how to connect a container to an Azure resource with managed identities and RBAC" weight: 600 slug: 'azure-connection' -categories: "Quickstart" +categories: "How-To" tags: ["Azure","containers"] --- -This quickstart will provide an overview of how to: +This how-to guide will provide an overview of how to: - Setup a Radius environment with an identity provider - Define a connection to an Azure resource with Azure AD role-based access control (RBAC) assignments diff --git a/docs/content/getting-started/quickstarts/quickstart-container-wi/snippets/container-wi.bicep b/docs/content/author-apps/platform-resources/howto-azure-resources/snippets/container-wi.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-container-wi/snippets/container-wi.bicep rename to docs/content/author-apps/platform-resources/howto-azure-resources/snippets/container-wi.bicep diff --git a/docs/content/author-apps/platform-resources/kubernetes/index.md b/docs/content/author-apps/platform-resources/kubernetes/index.md index 00168dcf7..8f4140ebc 100644 --- a/docs/content/author-apps/platform-resources/kubernetes/index.md +++ b/docs/content/author-apps/platform-resources/kubernetes/index.md @@ -1,7 +1,7 @@ --- type: docs title: "Kubernetes resources" -linkTitle: "Kubernetes" +linkTitle: "Overview: Kubernetes" description: "Deploy and connect to Kubernetes resources in your application" weight: 1000 categories: "Overview" diff --git a/docs/content/contributing/contributing-docs/index.md b/docs/content/contributing/contributing-docs/index.md index 1bd85f247..548fbd7e0 100644 --- a/docs/content/contributing/contributing-docs/index.md +++ b/docs/content/contributing/contributing-docs/index.md @@ -204,7 +204,6 @@ Front-matter should be completed with all fields including type, title, linkTitl - `categories` should be one of the following: - Concept - Overview - - Quickstart - Reference application - How-To - `tags` should be a comma-separated list of metadata tags. @@ -575,15 +574,15 @@ By default, buttons are padded with new lines below the button. To remove these You can use the `categorizeby` shortcode to pull and organize content by either categories and tags. This is useful when you want to categorize content by tags and the type of the document ``` -{{ categorizeby category="Quickstart" tag= "containers" }} +{{ categorizeby category="How-To" tag= "containers" }} ``` -This categorizes and lists all the docs that has both "quickstart" as the category and "container" as the tag. +This categorizes and lists all the docs that has both "How-To" as the category and "container" as the tag. ``` -{{ categorizeby category="Quickstart" }} +{{ categorizeby category="How-To" }} ``` -This categorizes and lists all the docs that are quickstart by the available tags. +This categorizes and lists all the docs that are How-To by the available tags. ### References diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/icon.png b/docs/content/deploy-apps/howto-cicd/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/icon.png rename to docs/content/deploy-apps/howto-cicd/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/index.md b/docs/content/deploy-apps/howto-cicd/index.md similarity index 96% rename from docs/content/getting-started/quickstarts/quickstart-cicd/index.md rename to docs/content/deploy-apps/howto-cicd/index.md index d1a70c57c..42d85a9d5 100644 --- a/docs/content/getting-started/quickstarts/quickstart-cicd/index.md +++ b/docs/content/deploy-apps/howto-cicd/index.md @@ -1,10 +1,10 @@ --- type: docs -title: "Quickstart: Github Actions CI/CD integration" -linkTitle: "GitHub Actions CI/CD" -description: "Learn about adding your Radius apps to your deployment pipelines" +title: "How-To: Deploy an application with Github Actions" +linkTitle: "How-To: GitHub Actions" +description: "Learn about adding your Radius apps to your deployment pipelines with GitHub Actions" weight: 300 -categories: "Quickstart" +categories: "How-To" tags: ["CI/CD"] --- diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/snippets/app.bicep b/docs/content/deploy-apps/howto-cicd/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/snippets/app.bicep rename to docs/content/deploy-apps/howto-cicd/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-cicd/snippets/env.bicep b/docs/content/deploy-apps/howto-cicd/snippets/env.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-cicd/snippets/env.bicep rename to docs/content/deploy-apps/howto-cicd/snippets/env.bicep diff --git a/docs/content/getting-started/first-app/_index.md b/docs/content/getting-started/first-app/_index.md index f10f369af..a1b922041 100644 --- a/docs/content/getting-started/first-app/_index.md +++ b/docs/content/getting-started/first-app/_index.md @@ -161,4 +161,4 @@ It's easy to build on the default app and add more resources to the app. To delete your app, see [rad app delete]({{< ref rad_application_delete >}}).
-{{< button text="Next step: Radius Quickstarts" page="getting-started/quickstarts" >}} +{{< button text="Next step: Radius Tutorials" page="tutorials" >}} diff --git a/docs/content/getting-started/install/index.md b/docs/content/getting-started/install/index.md index 0dab4ac74..526ad0bb5 100644 --- a/docs/content/getting-started/install/index.md +++ b/docs/content/getting-started/install/index.md @@ -182,6 +182,6 @@ Visual Studio Code offers the best authoring experience for Radius and Bicep. Do | Guides | Description | | --- | ----------- | | [Run your first app]({{< ref first-app >}}) | Take a tour of Radius by running your first app | -| [Quickstarts]({{< ref quickstarts >}}) | Learn about Radius topics via quickstart guides, complete with code samples | +| [Tutorials]({{< ref tutorials >}}) | Learn about Radius via guided tutorial, complete with code samples | | [Reference Applications]({{< ref reference-apps >}}) | See how full applications are modeled in Radius | | [Supported Languages]({{< ref supported-languages >}}) | Learn how to model apps using various IaC tools | diff --git a/docs/content/getting-started/quickstarts/_index.md b/docs/content/getting-started/quickstarts/_index.md deleted file mode 100644 index f0de7bf14..000000000 --- a/docs/content/getting-started/quickstarts/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -type: docs -title: "Quickstart guides" -linkTitle: "Quickstarts" -description: "Learn about Radius topics via quickstart guides, complete with code samples" -weight: 200 -no_list: true ---- - -{{< categorizeby category="Quickstart">}} - diff --git a/docs/content/getting-started/reference-apps/aws-rds/index.md b/docs/content/getting-started/reference-apps/aws-rds/index.md index e971fbdb6..d8bfaf3be 100644 --- a/docs/content/getting-started/reference-apps/aws-rds/index.md +++ b/docs/content/getting-started/reference-apps/aws-rds/index.md @@ -15,7 +15,7 @@ This reference app will show you: ## Prerequisites -- [Complete the getting started guide for AWS up to Step 2]({{< ref quickstart-aws-s3 >}}) +- [Complete the getting started guide for AWS up to Step 2]({{< ref howto-aws-resources >}}) ## Step 1: Create a Bicep file which uses AWS RDS diff --git a/docs/content/getting-started/reference-apps/aws-sqs/_index.md b/docs/content/getting-started/reference-apps/aws-sqs/_index.md index bd8f964c5..d97aee3ec 100644 --- a/docs/content/getting-started/reference-apps/aws-sqs/_index.md +++ b/docs/content/getting-started/reference-apps/aws-sqs/_index.md @@ -17,7 +17,7 @@ This reference app will show you: ## Prerequisites -- [Complete the getting started guide for AWS up to Step 2]({{< ref quickstart-aws-s3 >}}) +- [Complete the getting started guide for AWS up to Step 2]({{< ref howto-aws-resources >}}) ## Step 1: Create a Bicep file which uses AWS Simple Queue Service (SQS) @@ -37,7 +37,7 @@ This application models two http services: (1) `producer` and (2) `consumer` tha rad deploy ./app.bicep -p aws_access_key_id=$AWS_ACCESS_KEY_ID -p aws_secret_access_key=$AWS_SECRET_ACCESS_KEY -p aws_region=$AWS_REGION -p queue_name='queue' ``` - The access key, secret key, and region can be the same values you used in the [AWS Quickstart]({{< ref quickstart-aws-s3 >}}). These are used so the container we are deploying can connect to AWS. The AWS SQS Queue name must follow the [`Queue name` conventions](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-queues.html). + The access key, secret key, and region can be the same values you used in the [AWS How-To guide]({{< ref howto-aws-resources >}}). These are used so the container we are deploying can connect to AWS. The AWS SQS Queue name must follow the [`Queue name` conventions](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-queues.html). 1. Port-forward the container to your machine with [`rad resource expose`]({{< ref rad_resource_expose >}}): diff --git a/docs/content/operations/environments/overview/index.md b/docs/content/operations/environments/overview/index.md index b488a477b..5bc6a1d80 100644 --- a/docs/content/operations/environments/overview/index.md +++ b/docs/content/operations/environments/overview/index.md @@ -41,8 +41,6 @@ Supported identity providers: - [Azure AD workload identity](https://azure.github.io/azure-workload-identity/docs/introduction.html) -Visit the Azure direct connection quickstart for more information. (coming soon) - ## CLI commands The following commands let you interact with Radius environments: diff --git a/docs/content/reference/limitations.md b/docs/content/reference/limitations.md index c30c3bcc1..38b746923 100644 --- a/docs/content/reference/limitations.md +++ b/docs/content/reference/limitations.md @@ -10,7 +10,7 @@ weight: 998 ### `rad install kubernetes` and `rad init` installs Contour in addition to Radius -Contour is also installed into the `radius-system` namespace to help get you up and running quickly for our quickstarts and tutorial. This is a point-in-time limitation that will be addressed with richer environment customization in a future update. +Contour is also installed into the `radius-system` namespace to help get you up and running quickly. This is a point-in-time limitation that will be addressed with richer environment customization in a future update. ## Radius resources diff --git a/docs/content/tutorials/_index.md b/docs/content/tutorials/_index.md new file mode 100644 index 000000000..b759334d2 --- /dev/null +++ b/docs/content/tutorials/_index.md @@ -0,0 +1,7 @@ +--- +type: docs +title: "Tutorials" +linkTitle: "Tutorials" +description: "Follow along with a set of tutorials to learn how to use the Radius platform" +weight: 25 +--- diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/frontend.png b/docs/content/tutorials/tutorial-dapr/frontend.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/frontend.png rename to docs/content/tutorials/tutorial-dapr/frontend.png diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/icon.png b/docs/content/tutorials/tutorial-dapr/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/icon.png rename to docs/content/tutorials/tutorial-dapr/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md similarity index 88% rename from docs/content/getting-started/quickstarts/quickstart-dapr/index.md rename to docs/content/tutorials/tutorial-dapr/index.md index 47a0c0d59..a0630f044 100644 --- a/docs/content/getting-started/quickstarts/quickstart-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -1,20 +1,20 @@ --- type: docs -title: "Quickstart: Dapr Microservices" +title: "How-To: Dapr Microservices" linkTitle: "Dapr microservices" description: "Learn Radius by authoring templates and deploying a Dapr application" weight: 300 slug: "dapr" -categories: "Quickstart" +categories: "How-To" tags : ["Dapr"] --- -This quickstart will teach you: +This how-to guide will teach you: - How to use Radius to deploy a Dapr microservices sample application for an online shop - How [Dapr and Radius]({{< ref dapr-resources >}}) seamlessly work together -For more details on the app and access to the source code, visit the `quickstarts/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._ +For more details on the app and access to the source code, visit the `tutorials/dapr` directory in the [samples repo](https://github.com/project-radius/samples). _For access to the project-radius GitHub org, please complete and submit [this form](https://aka.ms/ProjectRadius/GitHubAccess)._ ## Prerequisites @@ -24,7 +24,7 @@ For more details on the app and access to the source code, visit the `quickstart - [Dapr installed on your Kubernetes cluster](https://docs.dapr.io/operations/hosting/kubernetes/kubernetes-deploy/) - [Visual Studio Code](https://code.visualstudio.com/) (recommended) - The [Radius VSCode extension]({{< ref "getting-started" >}}) is highly recommended to provide syntax highlighting, completion, and linting - - Although not recommended, you can also complete this quickstart with any basic text editor + - Although not recommended, you can also complete This how-to guide with any basic text editor ## Step 1: Define the application, `backend` container, and Dapr state store @@ -115,11 +115,11 @@ In your browser, navigate to the endpoint (e.g. [http://localhost:8080](http://l ## Next steps -- If you'd like to try another tutorial with your existing environment, go back to the [Radius quickstarts]({{< ref quickstarts >}}) page. +- If you'd like to try another tutorial with your existing environment, go back to the [Radius tutorials]({{< ref tutorials >}}) page. - Related links for Dapr: - [Dapr documentation](https://docs.dapr.io/) - [Dapr quickstarts](https://github.com/dapr/quickstarts/tree/v1.0.0/hello-world)
-{{< button text="Try another quickstart" page="quickstarts" >}} \ No newline at end of file +{{< button text="Try another tutorial" page="tutorials" >}} \ No newline at end of file diff --git a/docs/content/getting-started/quickstarts/quickstart-dapr/snippets/dapr.bicep b/docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-dapr/snippets/dapr.bicep rename to docs/content/tutorials/tutorial-dapr/snippets/dapr.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/icon.png b/docs/content/tutorials/tutorial-recipe/icon.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/icon.png rename to docs/content/tutorials/tutorial-recipe/icon.png diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md similarity index 96% rename from docs/content/getting-started/quickstarts/quickstart-recipe/index.md rename to docs/content/tutorials/tutorial-recipe/index.md index 282cec5e4..1e95ad256 100644 --- a/docs/content/getting-started/quickstarts/quickstart-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -1,15 +1,15 @@ --- type: docs -title: "Quickstart: Deploy Recipes in your Radius Application" +title: "How-To: Deploy Recipes in your Radius Application" linkTitle: "Recipes" description: "Learn how to use Radius Recipes within your application" weight: 500 slug: "recipes" -categories: "Quickstart" +categories: "How-To" tags : ["recipes"] --- -This quickstart will teach you: +This how-to guide will teach you: * How to use “dev” Recipes in your Radius Environment to quickly run with containerized infrastructure. * How to deploy your own Recipes in your Radius Environment to leverage cloud resources. @@ -65,7 +65,7 @@ Developers don't need to specify what cloud resources they're using in their app ``` {{< alert title="💡 Dev Recipes" color="info" >}} - Dev environments are preloaded with [`dev` Recipes]({{< ref "/author-apps/recipes#use-community-dev-recipes" >}}), a set of Recipes that allow you to quickly get up and running with lightweight containerized infrastructure. In this quickstart, the dev Redis Recipe deploys a lightweight Redis container into your Kubernetes cluster. + Dev environments are preloaded with [`dev` Recipes]({{< ref "/author-apps/recipes#use-community-dev-recipes" >}}), a set of Recipes that allow you to quickly get up and running with lightweight containerized infrastructure. In This how-to guide, the dev Redis Recipe deploys a lightweight Redis container into your Kubernetes cluster. When a Recipe is named "default" it will be used by default when deploying resources when a Recipe is not specified. {{< /alert >}} diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/recipe-quickstart-diagram.png b/docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/recipe-quickstart-diagram.png rename to docs/content/tutorials/tutorial-recipe/recipe-quickstart-diagram.png diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app-azure.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app-azure.bicep rename to docs/content/tutorials/tutorial-recipe/snippets/app-azure.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app.bicep b/docs/content/tutorials/tutorial-recipe/snippets/app.bicep similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/snippets/app.bicep rename to docs/content/tutorials/tutorial-recipe/snippets/app.bicep diff --git a/docs/content/getting-started/quickstarts/quickstart-recipe/todoapp.png b/docs/content/tutorials/tutorial-recipe/todoapp.png similarity index 100% rename from docs/content/getting-started/quickstarts/quickstart-recipe/todoapp.png rename to docs/content/tutorials/tutorial-recipe/todoapp.png