Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove quickstarts from docs #683

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/config/en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ PowerShell
Pre
PubSub
ProjectRadius
Quickstart
Quickstarts
RBAC
RabbitMQ
ResourceDeploymentClient
Expand Down Expand Up @@ -291,8 +289,6 @@ publickey
publicEndpointOverride
pubsub
px
quickstart
quickstarts
rabbitMQMessageQueues
rabbitmq
radapp
Expand Down Expand Up @@ -433,3 +429,5 @@ rabbitMQ
azureCache
listKeys
primaryKey
quickstart
quickstarts
9 changes: 9 additions & 0 deletions docs/content/author-apps/container/_index.md
Original file line number Diff line number Diff line change
@@ -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"]
---
Original file line number Diff line number Diff line change
@@ -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"]
---
Expand Down Expand Up @@ -96,5 +96,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" >}}
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/content/author-apps/platform-resources/aws/index.md
Original file line number Diff line number Diff line change
@@ -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"]
---
Expand Down
4 changes: 2 additions & 2 deletions docs/content/author-apps/platform-resources/azure/index.md
Original file line number Diff line number Diff line change
@@ -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"]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
24 changes: 7 additions & 17 deletions docs/content/contributing/contributing-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,15 @@ The docs pipeline uses [aspell](http://aspell.net/) to check for spelling mistak
- Determine the category or the type of doc you are contributing.
- **Concept** - A concept doc is a high-level overview of the project or an area of the project.
- **Overview** - A overview page documents a specific feature or capability of the project, with information on what the feature is and additional context and links on how to use it.
- **Quickstart** - A quickstart guide is a short step-by-step guide to help the reader quickly learn something and achieve a specific goal in 5-10 mins.
- **Reference app** - A reference app-doc is for running an application sample or an example of using the project or a particular feature.
- **How-To** - A how-to guide is an elaborate step-by-step guide to help the reader achieve a specific goal. It should provide the reader with an in-depth understanding of what the feature does. While Quickstart is a subset of How-To, they can be differentiated by the time to achieve a specific goal.
- **How-To** - A how-to guide is an elaborate step-by-step guide to help the reader achieve a specific goal. It should provide the reader with an in-depth understanding of what the feature does.

### Contributing a new Concept doc

- Ensure the doc is in the correct place in the hierarchy.
- Ensure the reader can understand why they should care about the project or the concept. What problems does it help them solve?
- Provide a link to the overview page of the feature that justifies the concept(s)
- Also provide the reader with related links if needed (this can be other quickstarts, "how-to", samples for reference)
- Also provide the reader with related links if needed (this can be other how-to guides, samples for reference)
- Set the `category` as `Concept` in [Hugo front-matter](#front-matter).

### Contributing a new Overview doc
Expand All @@ -130,17 +129,9 @@ The docs pipeline uses [aspell](http://aspell.net/) to check for spelling mistak
- Ensure the reader can understand why they should care about the feature and what it enables them to do.
- If applicable, ensure the doc references the reference spec document.
- If applicable, ensure the doc is consistent with any related concepts or specs in terms of names, parameters, and terminology. Update both the concept, spec, and the doc as needed. Avoid repeating the spec. The idea is to give the reader more information and background on the capability so that they can try this out.
- Provide a link to the spec in the [Reference]({{<ref reference >}}) section and provide the reader with related links (this can be other quickstarts, "how-to", samples for reference )
- Provide a link to the spec in the [Reference]({{<ref reference >}}) section and provide the reader with related links (this can be other how-to guides, samples for reference )
- Set the `category` as `Overview` in [Hugo front-matter](#front-matter).

### Contributing a new Quickstart

- Make sure the guide stays within 5-6 steps.
- Include code/sample/config snippets that can be easily copied and pasted.
- Do not assume the reader is using a specific environment unless the article itself is specific to an environment. This includes OS (Windows/Linux/MacOS), deployment target (Kubernetes, IoT, etc.), or programming language. If instructions vary between operating systems, provide guidance for all.-
- Do not explain all the jargon or features of the quickstart references, provide the reader with related links and next steps (this can be other "how-to", samples for reference, or related concepts).
- Set the `category` as `Quickstart` in [Hugo front-matter](#front-matter).

### Contributing a new How-To guide

- Sub directory naming - the directory name should be descriptive and if referring to a specific component or concept should begin with the relevant name. Example *pubsub-namespaces*.
Expand Down Expand Up @@ -210,7 +201,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.
Expand Down Expand Up @@ -581,15 +571,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

Expand Down
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/getting-started/first-app/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,4 +165,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 >}}).

<br>
{{< button text="Next step: Radius Quickstarts" page="getting-started/quickstarts" >}}
{{< button text="Next step: Radius Tutorials" page="tutorials" >}}
2 changes: 1 addition & 1 deletion docs/content/getting-started/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
11 changes: 0 additions & 11 deletions docs/content/getting-started/quickstarts/_index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this file name is causing issues with how the side bar renders and resulting in the S3 page being blank:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's an existing issue that exists already on docs.radapp.dev. I can get that fixed when I go in to remove the reference apps in a follow up PR

Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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 >}}):

Expand Down
2 changes: 0 additions & 2 deletions docs/content/operations/environments/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 7 additions & 0 deletions docs/content/tutorials/_index.md
Original file line number Diff line number Diff line change
@@ -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
---
Original file line number Diff line number Diff line change
@@ -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)._
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the samples/quickstarts/... need to be renamed as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes the container image names will need to be updated, but that will require a PR into the samples repo and redoing the CI/CD systems. Opened an Issue to track as part of a follow up PR: radius-project/samples#462


## Prerequisites

Expand All @@ -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

Expand Down Expand Up @@ -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)

<br>

{{< button text="Try another quickstart" page="quickstarts" >}}
{{< button text="Try another tutorial" page="tutorials" >}}
Loading
Loading