From 41c93b378aaf3caae3c645a257eb09467fde24bc Mon Sep 17 00:00:00 2001 From: Emanuel Palm Date: Mon, 27 Nov 2023 14:59:27 -0800 Subject: [PATCH] Markdown numbering consistency and updated contribution guide (#983) * explanation of numbered lists for markdown in contribution guide * numbered lists changed to 1 for all markdown Signed-off-by: Emanuel Palm --------- Signed-off-by: Emanuel Palm Signed-off-by: Aaron Crawfis Co-authored-by: Aaron Crawfis --- docs/README.md | 8 ++-- .../contributing/contributing-docs/index.md | 40 ++++++++++++------- .../concepts/architecture-concept/index.md | 12 +++--- docs/content/concepts/faq/index.md | 2 +- .../aws/howto-aws-resources/index.md | 4 +- .../azure/howto-azure-resources/index.md | 4 +- .../containers/howto-keyvault-volume/index.md | 6 +-- .../kubernetes/how-to-patch-pod/index.md | 4 +- .../environments/howto-environment/index.md | 6 +-- .../guides/deploy-apps/howto-delete/index.md | 2 +- .../control-plane/logs/fluentd/index.md | 26 ++++++------ .../control-plane/metrics/prometheus/index.md | 4 +- .../control-plane/traces/jaeger/index.md | 8 ++-- .../control-plane/traces/zipkin/index.md | 6 +-- .../providers/howto-aws-provider/index.md | 2 +- .../providers/howto-azure-provider/index.md | 5 ++- .../guides/recipes/howto-dev-recipes/index.md | 5 +-- docs/content/tutorials/helm/index.md | 28 ++++++------- .../tutorials/tutorial-add-radius/index.md | 20 +++++----- docs/content/tutorials/tutorial-dapr/index.md | 4 +- .../tutorials/tutorial-recipe/index.md | 18 ++++----- .../vscode-bicep/install-vscode-bicep.md | 10 ++--- 22 files changed, 117 insertions(+), 107 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8c464447d..3f78356f1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,10 +7,10 @@ This directory contains the files to generate the https://docs.radapp.io site. P The easiest way to get up and runnning with a docs environment is a GitHub codespace. 1. Open codespace -2. Ensure postCreate script has completed (takes ~2 minutes) -3. Run `cd docs` to change into the docs directory -4. Run `npm run start` to run a docs server -5. Click the `localhost:1313` link in your terminal to open the Codespace tunnel to the page +1. Ensure postCreate script has completed (takes ~2 minutes) +1. Run `cd docs` to change into the docs directory +1. Run `npm run start` to run a docs server +1. Click the `localhost:1313` link in your terminal to open the Codespace tunnel to the page ## Local machine diff --git a/docs/content/community/contributing/contributing-docs/index.md b/docs/content/community/contributing/contributing-docs/index.md index 9d49159fd..c0bd16afb 100644 --- a/docs/content/community/contributing/contributing-docs/index.md +++ b/docs/content/community/contributing/contributing-docs/index.md @@ -26,10 +26,10 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu > Note the `postCreateCommand` may take up to 3 minutes to complete after the codespace is created to complete. 1. Start Codespace -2. Wait for `postCreateCommand` to complete -3. Run `cd docs` to enter the hugo site directory -4. Run `hugo server` to start the local server -5. Click on the link in the terminal to open the docs in your browser +1. Wait for `postCreateCommand` to complete +1. Run `cd docs` to enter the hugo site directory +1. Run `hugo server` to start the local server +1. Click on the link in the terminal to open the docs in your browser ### Local machine @@ -42,14 +42,14 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu ### Environment setup 1. Ensure pre-requisites are installed -2. Clone this repository and the radius repository +1. Clone this repository and the radius repository ```sh git clone https://github.com/radius-project/radius.git git clone https://github.com/radius-project/docs.git ``` -3. Generate CLI docs: +1. Generate CLI docs: ```sh pushd radius @@ -57,20 +57,20 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu popd ``` -4. Update submodules: +1. Update submodules: ```sh cd docs git submodule update --init --recursive ``` -5. Install npm packages: +1. Install npm packages: ```sh npm install ``` -6. Initialize the docsy theme: +1. Initialize the docsy theme: ```sh cd themes/docsy @@ -81,13 +81,13 @@ It's easy to get up and running with a GitHub Codespace. This will give you a fu ### Run local server 1. Make sure you're still in the `docs` directory -2. Run +1. Run ```sh hugo server ``` -3. Navigate to `http://localhost:1313/` +1. Navigate to `http://localhost:1313/` ## Developer Certificate of Origin @@ -114,9 +114,9 @@ Visual Studio Code has a setting, `git.alwaysSignOff` to automatically add a Sig There are 5 types of docs in Radius: 1. **Concept** - A concept doc is a high-level overview of the project or an area of the project. -2. **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. -3. **How-To** - A how-to guide is a step-by-step guide to help the reader achieve a specific task. It assumes the reader has a basic understanding of the project and its concepts. For more information on how-to guides, see [Diátaxis](https://diataxis.fr/how-to-guides/). -4. **Reference** - A reference doc is a detailed description of a specific feature or capability of the project. It assumes the reader has a basic understanding of the project and its concepts. For more information on reference docs, see [Diátaxis](https://diataxis.fr/reference/). +1. **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. +1. **How-To** - A how-to guide is a step-by-step guide to help the reader achieve a specific task. It assumes the reader has a basic understanding of the project and its concepts. For more information on how-to guides, see [Diátaxis](https://diataxis.fr/how-to-guides/). +1. **Reference** - A reference doc is a detailed description of a specific feature or capability of the project. It assumes the reader has a basic understanding of the project and its concepts. For more information on reference docs, see [Diátaxis](https://diataxis.fr/reference/). Overall: @@ -177,6 +177,18 @@ These conventions should be followed throughout all Radius documentation to ensu The docs pipeline uses [aspell](http://aspell.net/) to check for spelling mistakes. If you need to add a new custom word to the allow-list, update `.github/config/en-custom.txt`. +### Numbering + +All numbered lists use `1.` as the number, regardless of the order. The list numbers are then incremented automatically during the build process of the docs. + +#### Example + +```md +1. This is the second step, and will be displayed with a 2 in the docs. +1. This is the third step, and will be displayed with a 3. +1. This is the first step of a process. +``` + ## Tips and tricks Any contribution must ensure not to break the website build. The way Hugo builds the website requires following the below guidance. diff --git a/docs/content/concepts/architecture-concept/index.md b/docs/content/concepts/architecture-concept/index.md index 372764235..108decbc7 100644 --- a/docs/content/concepts/architecture-concept/index.md +++ b/docs/content/concepts/architecture-concept/index.md @@ -130,9 +130,9 @@ This section describes example tasks that can be performed with Radius and how t When listing applications using the `rad` CLI: 1. The client sends an HTTP request to the Radius API requesting the list of applications. -2. UCP receives the request for the `Applications.Core/applications` List operation and looks up the internal address for the `Applications.Core` resource provider. -3. UCP proxies the HTTP request to the `Applications.Core` resource provider. -4. The `Applications.Core` resource provider handles the request and responds with the list of applications. +1. UCP receives the request for the `Applications.Core/applications` List operation and looks up the internal address for the `Applications.Core` resource provider. +1. UCP proxies the HTTP request to the `Applications.Core` resource provider. +1. The `Applications.Core` resource provider handles the request and responds with the list of applications. {{< image src="flow-list-apps.png" alt="Diagram of the API flow described above" width="1000px" >}} @@ -142,9 +142,9 @@ When listing applications using the `rad` CLI: When using Bicep to author and deploy Radius Applications: 1. The client compiles the Bicep file to an ARM-JSON template and submits a request for processing as a `Bicep.Deployments/deployments` resource. -2. UCP receives the request for the `Bicep.Deployments/deployments` Create operation and looks up the internal address for the `Bicep.Deployments` resource provider. -3. UCP proxies the HTTP request to the `Bicep.Deployments` resource provider. -4. The `Bicep.Deployments` resource provider processes the ARM-JSON template. For each resource in the template: +1. UCP receives the request for the `Bicep.Deployments/deployments` Create operation and looks up the internal address for the `Bicep.Deployments` resource provider. +1. UCP proxies the HTTP request to the `Bicep.Deployments` resource provider. +1. The `Bicep.Deployments` resource provider processes the ARM-JSON template. For each resource in the template: a. The `Bicep.Deployments` resource provider makes a request to UCP to Create/Update the resource. b. UCP routes the request to the appropriate resource provider to be handled. diff --git a/docs/content/concepts/faq/index.md b/docs/content/concepts/faq/index.md index 89b8f7197..12656ca7a 100644 --- a/docs/content/concepts/faq/index.md +++ b/docs/content/concepts/faq/index.md @@ -84,7 +84,7 @@ Yes. Radius has first-class support for [Dapr building blocks]({{< ref "/guides/ Radius leverages Kubernetes in two ways: 1. As a hosting platform for the Radius control-plane -2. As a runtime for containerized workloads +1. As a runtime for containerized workloads While Radius only supports Kubernetes today, it is architected to support other hosting platforms in the future, including serverless platforms. Radius is not a Kubernetes controller and the primary user experience is not through CRDs. Instead, Radius Applications are an abstraction layer on top of Kubernetes and other cloud platforms. diff --git a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md index 12e5005da..d002241dc 100644 --- a/docs/content/guides/author-apps/aws/howto-aws-resources/index.md +++ b/docs/content/guides/author-apps/aws/howto-aws-resources/index.md @@ -99,7 +99,7 @@ This creates a container that will be deployed to your Kubernetes cluster. This 1. When you're done with testing, you can use the rad CLI to [delete an environment]({{< ref rad_env_delete.md >}}) to delete all Radius resources running on the EKS Cluster. -2. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html). +1. Cleanup AWS Resources - AWS resources are not deleted when deleting a Radius Environment, so make sure to delete all resources created in this reference app to prevent additional charges. You can delete these resources in the AWS Console or via the AWS CLI. Instructions to delete an AWS S3 Bucket are available [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/delete-bucket.html). ## Troubleshooting @@ -107,7 +107,7 @@ If you hit errors while deploying the application, please follow the steps below 1. Check if the AWS credentials are valid. Login to the AWS console and check if the IAM access key and secret access key are valid and not expired. -2. Look at the control plane logs to see if there are any errors. You can use the following command to view the logs: +1. Look at the control plane logs to see if there are any errors. You can use the following command to view the logs: ```bash rad debug-logs diff --git a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md index 03b4fa6ee..a9608a548 100644 --- a/docs/content/guides/author-apps/azure/howto-azure-resources/index.md +++ b/docs/content/guides/author-apps/azure/howto-azure-resources/index.md @@ -60,7 +60,7 @@ rad deploy ./app.bicep -p oidcIssuer= rad resource logs containers mycontainer -a myapp ``` -2. You should see the contents of the secret from your Key Vault: +1. You should see the contents of the secret from your Key Vault: ```txt [myapp-mycontainer-79c54bd7c7-tgdpn] I1108 18:39:53.636314 1 main.go:33] "successfully got secret" secret="supersecret" @@ -76,4 +76,4 @@ rad deploy ./app.bicep -p oidcIssuer= rad app delete myapp --yes ``` -2. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI +1. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI diff --git a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md index 210bd5a92..927fda410 100644 --- a/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md +++ b/docs/content/guides/author-apps/containers/howto-keyvault-volume/index.md @@ -67,7 +67,7 @@ rad deploy ./app.bicep -p oidcIssuer= rad resource logs containers mycontainer -a myapp ``` -2. You should see the contents of the `/var/secrets` mount path defined in your `app.bicep` file: +1. You should see the contents of the `/var/secrets` mount path defined in your `app.bicep` file: ``` [myapp-mycontainer-d8b4fc44-qrhnn] secret context : supersecret @@ -82,5 +82,5 @@ rad deploy ./app.bicep -p oidcIssuer= ```bash rad app delete myapp --yes ``` - -2. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI + +1. Delete the deployed Azure Key Vault via the Azure portal or the Azure CLI diff --git a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md index c1b3344eb..65afeaeb5 100644 --- a/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md +++ b/docs/content/guides/author-apps/kubernetes/how-to-patch-pod/index.md @@ -56,7 +56,7 @@ Begin by creating a file named `app.bicep` with a Radius [container]({{< ref "gu
When you're ready to move on to the next step, use `CTRL` + `C` to exit the command. -2. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: +1. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: ```bash kubectl get pods -A -l app.kubernetes.io/name=demo -o custom-columns=POD:.metadata.name,STATUS:.status.phase,CONTAINER_NAMES:spec.containers[:].name,CONTAINER_IMAGES:spec.containers[:].image @@ -105,7 +105,7 @@ Add the following [`runtimes`]({{< ref "reference/resource-schema/core-schema/co
When you're ready to move on to the next step, use `CTRL` + `C` to exit the command. -2. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: +1. Run the command below, which will list the pods in your Kubernetes cluster, using the `-o` flag to specify the relevant information to output: ```bash kubectl get pods -A -l app.kubernetes.io/name=demo -o custom-columns=POD:.metadata.name,STATUS:.status.phase,CONTAINER_NAMES:spec.containers[:].name,CONTAINER_IMAGES:spec.containers[:].image diff --git a/docs/content/guides/deploy-apps/environments/howto-environment/index.md b/docs/content/guides/deploy-apps/environments/howto-environment/index.md index dddb7263c..b86fe8f1f 100644 --- a/docs/content/guides/deploy-apps/environments/howto-environment/index.md +++ b/docs/content/guides/deploy-apps/environments/howto-environment/index.md @@ -40,7 +40,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or ⏳ Update local configuration ``` -2. Verify the initialization by running: +1. Verify the initialization by running: ```bash kubectl get deployments -n radius-system ``` @@ -60,9 +60,7 @@ Radius Environments can be setup with the rad CLI via two paths: interactive or ```bash rad env list ``` - -3. Use `rad recipe list` to see the list of available Recipes: - +1. Use `rad recipe list` to see the list of available Recipes: ```bash rad recipe list ``` diff --git a/docs/content/guides/deploy-apps/howto-delete/index.md b/docs/content/guides/deploy-apps/howto-delete/index.md index 5f553016d..bb7eda08a 100644 --- a/docs/content/guides/deploy-apps/howto-delete/index.md +++ b/docs/content/guides/deploy-apps/howto-delete/index.md @@ -23,7 +23,7 @@ rad app delete This will delete the following resources from the Radius Environment 1. All the resources created by Radius on the Kubernetes cluster under the `-` namespace -2. All the resources provisioned by Recipes +1. All the resources provisioned by Recipes ## Step 2: Delete any cloud/platform resources diff --git a/docs/content/guides/operations/control-plane/logs/fluentd/index.md b/docs/content/guides/operations/control-plane/logs/fluentd/index.md index 1b46e4a71..e6ac7453c 100644 --- a/docs/content/guides/operations/control-plane/logs/fluentd/index.md +++ b/docs/content/guides/operations/control-plane/logs/fluentd/index.md @@ -22,14 +22,14 @@ tags: ["logs","observability"] kubectl create namespace radius-monitoring ``` -2. Add the helm repo for Elastic Search +1. Add the helm repo for Elastic Search ```bash helm repo add elastic https://helm.elastic.co helm repo update ``` -3. Install Elastic Search using Helm +1. Install Elastic Search using Helm _By default, the chart creates three replicas which must be on different nodes. If your cluster has fewer than 3 nodes, specify a smaller number of replicas with the `--set replicas=1` flag:_ @@ -43,13 +43,13 @@ tags: ["logs","observability"] helm install elasticsearch elastic/elasticsearch --version 7.17.3 -n radius-monitoring --set persistence.enabled=false,replicas=1 ``` -4. Install Kibana +1. Install Kibana ```bash helm install kibana elastic/kibana --version 7.17.3 -n radius-monitoring ``` -5. Ensure that Elastic Search and Kibana are running in your Kubernetes cluster +1. Ensure that Elastic Search and Kibana are running in your Kubernetes cluster ```bash kubectl get pods -n radius-monitoring @@ -80,7 +80,7 @@ tags: ["logs","observability"] kubectl apply -f ./fluentd-radius-with-rbac.yaml ``` -2. Ensure that Fluentd is running as a daemonset. The number of Fluentd instances should be the same as the number of cluster nodes. In the example below, there is only one node in the cluster: +1. Ensure that Fluentd is running as a daemonset. The number of Fluentd instances should be the same as the number of cluster nodes. In the example below, there is only one node in the cluster: ```bash kubectl get pods -n kube-system -w @@ -129,37 +129,37 @@ _Note: There is a small delay for Elastic Search to index the logs that Fluentd 1. Browse to `http://localhost:5601` -2. Expand the drop-down menu and click **Management → Stack Management** +1. Expand the drop-down menu and click **Management → Stack Management** ![Stack Management item under Kibana Management menu options](kibana-1.png) -3. On the Stack Management page, select **Data → Index Management** and wait until `radius-*` is indexed. +1. On the Stack Management page, select **Data → Index Management** and wait until `radius-*` is indexed. ![Index Management view on Kibana Stack Management page](kibana-2.png) -4. Once `radius-*` is indexed, click on **Kibana → Index Patterns** and then the **Create index pattern** button. +1. Once `radius-*` is indexed, click on **Kibana → Index Patterns** and then the **Create index pattern** button. ![Kibana create index pattern button](kibana-3.png) -5. Define a new index pattern by typing `radius*` into the **Index Pattern name** field, then click the **Next step** button to continue. +1. Define a new index pattern by typing `radius*` into the **Index Pattern name** field, then click the **Next step** button to continue. ![Kibana define an index pattern page](kibana-4.png) -6. Configure the primary time field to use with the new index pattern by selecting the `@timestamp` option from the **Time field** drop-down. Click the **Create index pattern** button to complete creation of the index pattern. +1. Configure the primary time field to use with the new index pattern by selecting the `@timestamp` option from the **Time field** drop-down. Click the **Create index pattern** button to complete creation of the index pattern. ![Kibana configure settings page for creating an index pattern](kibana-5.png) -7. The newly created index pattern should be shown. Confirm that the fields of interest such as `scope`, `type`, `app_id`, `level`, etc. are being indexed by using the search box in the **Fields** tab. +1. The newly created index pattern should be shown. Confirm that the fields of interest such as `scope`, `type`, `app_id`, `level`, etc. are being indexed by using the search box in the **Fields** tab. _Note: If you cannot find the indexed field, please wait. The time it takes to search across all indexed fields depends on the volume of data and size of the resource that the elastic search is running on._ ![View of created Kibana index pattern](kibana-6.png) -8. To explore the indexed data, expand the drop-down menu and click **Analytics → Discover**. +1. To explore the indexed data, expand the drop-down menu and click **Analytics → Discover**. ![Discover item under Kibana Analytics menu options](kibana-7.png) -9. In the search box, type in a query string such as `scope:*` and click the **Refresh** button to view the results. +1. In the search box, type in a query string such as `scope:*` and click the **Refresh** button to view the results. _Note: This can take a long time. The time it takes to return all results depends on the volume of data and size of the resource that the elastic search is running on._ diff --git a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md index 660b4e91f..809f65469 100644 --- a/docs/content/guides/operations/control-plane/metrics/prometheus/index.md +++ b/docs/content/guides/operations/control-plane/metrics/prometheus/index.md @@ -25,7 +25,7 @@ tags: ["metrics", "observability"] kubectl create namespace radius-monitoring ``` -2. Install Prometheus into your monitoring namespace: +1. Install Prometheus into your monitoring namespace: ```bash helm repo add prometheus-community https://prometheus-community.github.io/helm-charts @@ -39,7 +39,7 @@ tags: ["metrics", "observability"] helm install radius-prom prometheus-community/prometheus -n radius-monitoring --set alertmanager.persistentVolume.enable=false --set pushgateway.persistentVolume.enabled=false --set server.persistentVolume.enabled=false ``` -3. Validate your Prometheus installation: +1. Validate your Prometheus installation: ```bash kubectl get pods -n radius-monitoring diff --git a/docs/content/guides/operations/control-plane/traces/jaeger/index.md b/docs/content/guides/operations/control-plane/traces/jaeger/index.md index c69848960..637999290 100644 --- a/docs/content/guides/operations/control-plane/traces/jaeger/index.md +++ b/docs/content/guides/operations/control-plane/traces/jaeger/index.md @@ -24,17 +24,17 @@ The following steps show you how to configure the Radius control plane to send d kubectl create namespace radius-monitoring ``` -2. Create the file `jaeger.yaml`, and paste the following YAML: +1. Create the file `jaeger.yaml`, and paste the following YAML: {{< button text="Download jaeger.yaml" link="jaeger.yaml" >}} -3. Install Jaeger: +1. Install Jaeger: ```bash kubectl apply -f jaeger.yaml ``` -4. Wait for Jaeger to be up and running +1. Wait for Jaeger to be up and running ```bash kubectl wait deploy --selector app=jaeger --for=condition=available -n radius-monitoring @@ -58,7 +58,7 @@ The following steps show you how to configure the Radius control plane to send d kubectl port-forward svc/tracing 16686 -n radius-monitoring ``` -2. In your browser, go to [http://localhost:16686](http://localhost:16686) to see the Jaeger UI: +1. In your browser, go to [http://localhost:16686](http://localhost:16686) to see the Jaeger UI: {{< image src="jaeger_ui.png" alt="" style="width:100%" >}} diff --git a/docs/content/guides/operations/control-plane/traces/zipkin/index.md b/docs/content/guides/operations/control-plane/traces/zipkin/index.md index 498b2543b..c297e3396 100644 --- a/docs/content/guides/operations/control-plane/traces/zipkin/index.md +++ b/docs/content/guides/operations/control-plane/traces/zipkin/index.md @@ -24,7 +24,7 @@ The following steps show you how to configure the [Radius control plane]({{< ref kubectl create namespace radius-monitoring ``` -2. Deploy the Zipkin deployment and service: +1. Deploy the Zipkin deployment and service: ```bash kubectl create deployment zipkin --image openzipkin/zipkin -n radius-monitoring @@ -52,11 +52,11 @@ The following steps show you how to configure the [Radius control plane]({{< ref kubectl port-forward svc/zipkin 9411:9411 -n radius-monitoring ``` -2. In your browser, go to [http://localhost:9411](http://localhost:9411) to see the Zipkin UI and run a query: +1. In your browser, go to [http://localhost:9411](http://localhost:9411) to see the Zipkin UI and run a query: {{< image src="zipkin_ui.png" alt="" style="width:100%" >}} -3. Done! You can now use the Zipkin UI to view tracing data for your Radius control plane. +1. Done! You can now use the Zipkin UI to view tracing data for your Radius control plane. ## References diff --git a/docs/content/guides/operations/providers/howto-aws-provider/index.md b/docs/content/guides/operations/providers/howto-aws-provider/index.md index 8d5aa4042..e61f19ad2 100644 --- a/docs/content/guides/operations/providers/howto-aws-provider/index.md +++ b/docs/content/guides/operations/providers/howto-aws-provider/index.md @@ -59,7 +59,7 @@ The AWS provider allows you to deploy and connect to AWS resources from a Radius This command updates the configuration of an environment for properties that are able to be changed. For more information visit [`rad env update`]({{< ref rad_env_update >}}) -2. Add your AWS cloud provider credentials: +1. Add your AWS cloud provider credentials: ```bash rad credential register aws --access-key-id myAccessKeyId --secret-access-key mySecretAccessKey diff --git a/docs/content/guides/operations/providers/howto-azure-provider/index.md b/docs/content/guides/operations/providers/howto-azure-provider/index.md index 5d0472cb1..d55b95f9b 100644 --- a/docs/content/guides/operations/providers/howto-azure-provider/index.md +++ b/docs/content/guides/operations/providers/howto-azure-provider/index.md @@ -70,7 +70,7 @@ The Azure provider allows you to deploy and connect to Azure resources from a se rad env update myEnvironment --azure-subscription-id myAzureSubscriptionId --azure-resource-group myAzureResourceGroup ``` -2. Run `az ad sp create-for-rbac` to create a Service Principal without a role assignment and obtain your `appId`, `displayName`, `password`, and `tenant` information. +1. Run `az ad sp create-for-rbac` to create a Service Principal without a role assignment and obtain your `appId`, `displayName`, `password`, and `tenant` information. ``` { @@ -81,7 +81,8 @@ The Azure provider allows you to deploy and connect to Azure resources from a se } ``` -3. Use [`rad credential register azure`]({{< ref rad_credential_register_azure >}}) to add the Azure service principal to your Radius installation: + +1. Use [`rad credential register azure`]({{< ref rad_credential_register_azure >}}) to add the Azure service principal to your Radius installation: ```bash rad credential register azure --client-id myClientId --client-secret myClientSecret --tenant-id myTenantId diff --git a/docs/content/guides/recipes/howto-dev-recipes/index.md b/docs/content/guides/recipes/howto-dev-recipes/index.md index 8e9a6724b..69714be45 100644 --- a/docs/content/guides/recipes/howto-dev-recipes/index.md +++ b/docs/content/guides/recipes/howto-dev-recipes/index.md @@ -24,8 +24,7 @@ Local development environments created by the rad init command include a set of mkdir recipes cd recipes ``` - -2. Initialize a new dev environment: +1. Initialize a new dev environment: ```bash rad init @@ -33,7 +32,7 @@ Local development environments created by the rad init command include a set of **Select 'No' when prompted to create an application.** -3. Use [`rad recipe list`]({{< ref rad_recipe_list >}}) to view the Recipes in your environment: +1. Use [`rad recipe list`]({{< ref rad_recipe_list >}}) to view the Recipes in your environment: ```bash rad recipe list diff --git a/docs/content/tutorials/helm/index.md b/docs/content/tutorials/helm/index.md index 66bbdab64..cf6bf170d 100644 --- a/docs/content/tutorials/helm/index.md +++ b/docs/content/tutorials/helm/index.md @@ -108,7 +108,7 @@ rad init {{< alert title="💡 Redis" color="info" >}} For now you're not going to actually deploy Redis and the URL in this step is fake. You will deploy Redis using a Recipe later in the tutorial that will replace the fake URL contained within `redis-secret` with an actual container and URL.{{< /alert >}} -2. Complete these steps by running the following commands: +1. Complete these steps by running the following commands: ```bash kubectl create namespace demo @@ -137,7 +137,7 @@ rad init {{< alert title="⚠️ Chart Directory" color="warning" >}} If you see an error message like **Error: path "./Chart" not found** then you are in the wrong directory. Make sure your terminal is in the `./demo` directory of the `samples` repository.{{< /alert >}} -3. Run the following command to check if everything is running: +1. Run the following command to check if everything is running: ```bash kubectl get all -n demo @@ -198,7 +198,7 @@ From here you will go through a series of steps to incrementally add more Radius Adding the `radapp.io/enabled: 'true'` annotation enables Radius for the deployment. -2. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, we only need to run the `helm` command. +1. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, we only need to run the `helm` command. ```bash helm upgrade demo ./Chart -n demo --install @@ -219,7 +219,7 @@ From here you will go through a series of steps to incrementally add more Radius You should confirm that your output contains `REVISION: 2`, that means that the changes were applied. -3. Run the following command to confirm that everything is running: +1. Run the following command to confirm that everything is running: ```bash kubectl get all -n demo @@ -241,7 +241,7 @@ From here you will go through a series of steps to incrementally add more Radius Notice that the `AGE` of `pod/webapp-...` reflects the time of your **first** deployment. Enabling Radius for an application does not change any of its behaviors, so Kubernetes did not need to restart the container. -4. Now that Radius has been enabled, run this command to display the state of the Radius application: +1. Now that Radius has been enabled, run this command to display the state of the Radius application: ```bash rad app graph -a demo -g default-demo @@ -301,7 +301,7 @@ In this step you will: In a production environment you can substitute recipes that will create cloud or on-premises dependencies instead. {{< /alert >}} -2. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. At the bottom of the file add the following text, including the `---`: +1. Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in your editor. At the bottom of the file add the following text, including the `---`: ```yaml --- @@ -320,7 +320,7 @@ In this step you will: - The `.spec.type` field defines the type of resource to create. `Applications.Datastores/redisCaches` is the type for a Redis Cache. - The `.spec.secretName` field tells Radius where to store connection information. This is optional, and should be used to interoperate with other Kubernetes technologies that read from secrets. This tutorial example uses the secret to populate an environment variable. -3. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, you only need to run the `helm` command. +1. Save the file after you have made the edits and deploy the application again using Helm. Since the namespace and secret have already been created, you only need to run the `helm` command. ```bash helm upgrade demo ./Chart -n demo --install @@ -341,7 +341,7 @@ In this step you will: This time you should see `REVISION: 3`. -4. Now that you are using a Recipe, you should see more resources running in Kubernetes. Run the following command: +1. Now that you are using a Recipe, you should see more resources running in Kubernetes. Run the following command: ```bash kubectl get all -n demo @@ -374,7 +374,7 @@ In this step you will: {{< alert title="⚠️ Missing resources" color="warning" >}} If you do not see the additional resources starting with `redis-` then it's likely they are in a different Kubernetes namespace. Run `kubectl get all -A` to see everything.{{< /alert >}} -5. Now that you have added a Recipe, run this command to display the state of the Radius application: +1. Now that you have added a Recipe, run this command to display the state of the Radius application: ```bash rad app graph -a demo -g default-demo @@ -406,7 +406,7 @@ In this step you will: The Redis Cache created by the recipe is visible as part of the application. You can also see the `Resources` created in Kubernetes that make up the Redis Cache. In a previous step you saw these listed by `kubectl`. Since Radius deployed the Recipe, it knows that these resources *logically* are part of the Redis Cache in the application. -6. You can also see the contents of `redis-secret` as created by Radius. Run the following command: +1. You can also see the contents of `redis-secret` as created by Radius. Run the following command: ```bash kubectl get secret -n demo redis-secret -o yaml @@ -476,7 +476,7 @@ Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in Since you're using a connection called `redis`, Radius will automatically define the `CONNECTION_REDIS_URL` environment variable. The prefix of `CONNECTION_REDIS_` will be combined with each of the settings that you could see in the `redis-secret` secret in the previous step. -2. You can remove the manual definition of `CONNECTION_REDIS_URL` from `app.yaml` since Radius will provide it automatically. Find the `env` property and delete all of its contents. You can also remove `.spec.secretName` from the `Recipe`. +1. You can remove the manual definition of `CONNECTION_REDIS_URL` from `app.yaml` since Radius will provide it automatically. Find the `env` property and delete all of its contents. You can also remove `.spec.secretName` from the `Recipe`. The final contents of `app.yaml` should look like: @@ -513,7 +513,7 @@ Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in type: Applications.Datastores/redisCaches ``` -3. Save the file after you have made the edits and deploy the application again using Helm. +1. Save the file after you have made the edits and deploy the application again using Helm. ```bash helm upgrade demo ./Chart -n demo --install @@ -567,7 +567,7 @@ Make sure the `app.yaml` file from `./demo/Chart/templates/app.yaml` is open in Depending on the timing you may see pods in the `Terminating` state. This is normal as old replicas take some time to shut down. -4. Check the Radius status again. Now Radius is aware of the connection from `webapp->db`: +1. Check the Radius status again. Now Radius is aware of the connection from `webapp->db`: ```bash rad app graph -a demo -g default-demo @@ -614,7 +614,7 @@ In this step you can access the application and explore its features. Since the You can use the homepage to view information about the container and its settings. -2. Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis. +1. Navigate to the ToDo List tab and test out the application. Using the ToDo page will update the saved state in Redis. Screenshot of the todolist

diff --git a/docs/content/tutorials/tutorial-add-radius/index.md b/docs/content/tutorials/tutorial-add-radius/index.md index 6cb5fc0ad..9ec1f3500 100644 --- a/docs/content/tutorials/tutorial-add-radius/index.md +++ b/docs/content/tutorials/tutorial-add-radius/index.md @@ -40,7 +40,7 @@ The Guestbook application consists of a web front end along with primary and sec git clone https://github.com/radius-project/samples.git ``` -2. Navigate to the `samples/kubernetes/guestbook` directory: +1. Navigate to the `samples/kubernetes/guestbook` directory: ```bash cd samples/kubernetes/guestbook @@ -48,7 +48,7 @@ The Guestbook application consists of a web front end along with primary and sec > The `kubernetes/guestbook` directory contains the Kubernetes YAML manifest files for their Guestbook sample application, copied directly from the [Kubernetes examples repo](https://github.com/kubernetes/examples/tree/master/guestbook). -3. Initialize Radius +1. Initialize Radius: Run this command to initialize Radius. For this example, answer **NO** when asked whether to set up an application: @@ -78,13 +78,13 @@ Step 2: Deploy and test the existing Guestbook application using `kubectl` kubectl create namespace demo ``` -2. Create and deploy the Guestbook application to the `demo` namespace: +1. Create and deploy the Guestbook application to the `demo` namespace: ```bash kubectl apply -n demo -f ./deploy ``` -3. Verify that the application successfully deployed: +1. Verify that the application successfully deployed: ```bash kubectl get all -n demo @@ -117,7 +117,7 @@ Step 2: Deploy and test the existing Guestbook application using `kubectl` replicaset.apps/frontend-77dfc58d7c 3 3 3 10s ``` -4. Validate that the application is running as expected: +1. Validate that the application is running as expected: Run this command to port forward the Guestbook application to port `8080` on your local machine: @@ -131,7 +131,7 @@ Step 2: Deploy and test the existing Guestbook application using `kubectl` Terminate the port forwarding process by pressing `CTRL+C` in your terminal. -5. Confirm that Radius has not yet been added: +1. Confirm that Radius has not yet been added: Run this command to view the state of your application using Radius: @@ -209,7 +209,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man - containerPort: 80 ``` -2. Save your changes to the YAML files. +1. Save your changes to the YAML files. ## Step 4: Deploy and test the updated Guestbook application using `kubectl` @@ -219,7 +219,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man kubectl apply -n demo -f ./deploy ``` -2. Verify that the application successfully deployed: +1. Verify that the application successfully deployed: ```bash kubectl get deployments -n demo @@ -239,7 +239,7 @@ You will now add Radius to the Guestbook application's Kubernetes deployment man redis-replica ClusterIP 10.43.118.183 6379/TCP 10m ``` -3. Validate that the application is running as expected: +1. Validate that the application is running as expected: Once again, run this command to port forward the Guestbook application to port `8080` on your local machine: @@ -303,7 +303,7 @@ This output shows that Radius has detected the three container resources in the service "redis-replica" deleted ``` -2. Run the following command to delete the `demo` namespace: +1. Run the following command to delete the `demo` namespace: ```bash kubectl delete namespace demo diff --git a/docs/content/tutorials/tutorial-dapr/index.md b/docs/content/tutorials/tutorial-dapr/index.md index 48f1b9901..fedb7020e 100644 --- a/docs/content/tutorials/tutorial-dapr/index.md +++ b/docs/content/tutorials/tutorial-dapr/index.md @@ -32,8 +32,8 @@ For more details on the app and access to the source code, visit the `tutorials/ mkdir dapr cd dapr ``` - -2. Initialize a new dev environment: + +1. Initialize a new dev environment: *Select 'Yes' when prompted to create an application.* diff --git a/docs/content/tutorials/tutorial-recipe/index.md b/docs/content/tutorials/tutorial-recipe/index.md index bc2af1987..23ff53618 100644 --- a/docs/content/tutorials/tutorial-recipe/index.md +++ b/docs/content/tutorials/tutorial-recipe/index.md @@ -44,7 +44,7 @@ Developers don't need to specify what cloud resources they're using in their app mkdir recipes cd recipes ``` -2. Initialize a new dev environment: +1. Initialize a new dev environment: ```bash rad init @@ -52,7 +52,7 @@ Developers don't need to specify what cloud resources they're using in their app **Select 'Yes' when prompted to create an application.** -3. Use [`rad recipe list`]({{< ref rad_recipe_list >}}) to view the Recipes in your environment: +1. Use [`rad recipe list`]({{< ref rad_recipe_list >}}) to view the Recipes in your environment: ```bash rad recipe list @@ -114,7 +114,7 @@ Note that no Recipe name is specified with 'db', so it will be using the default Your application is now deployed and running in your Kubernetes cluster. -2. List your Kubernetes Pods to see the infrastructure container deployed by the Recipe: +1. List your Kubernetes Pods to see the infrastructure container deployed by the Recipe: ```bash kubectl get pods -n default-recipes @@ -128,13 +128,13 @@ Note that no Recipe name is specified with 'db', so it will be using the default redis-ymbjcqyjzwkpg-66fdbf8bb6-brb6q 2/2 Running 0 13m ``` -3. Port-forward the container to your machine with `rad resource expose`: +1. Port-forward the container to your machine with `rad resource expose`: ```bash rad resource expose containers frontend --port 3000 ``` -4. Visit [`http://localhost:3000`](http://localhost:3000) in your browser. +1. Visit [`http://localhost:3000`](http://localhost:3000) in your browser. You can now see both the environment variables of your container under Radius Connections as well as interact with the `Todo App` and add/remove items in it as wanted: @@ -156,17 +156,17 @@ This step requires an Azure subscription or an AWS account to deploy cloud resou Follow the steps [here]({{< ref "howto-azure-provider#manual-configuration" >}}) to add the Azure cloud provider to your existing environment. -2. Register the Recipe to your Radius Environment: +1. Register the Recipe to your Radius Environment: ```bash rad recipe register azure --environment default --template-kind bicep --template-path ghcr.io/radius-project/recipes/azure/rediscaches:{{< param tag_version >}} --resource-type Applications.Datastores/redisCaches ``` -3. Update your db resource to use the `azure` Recipe, instead of the default Recipe: +1. Update your db resource to use the `azure` Recipe, instead of the default Recipe: {{< rad file="snippets/app-azure.bicep" marker="//DB" embed=true >}} -4. Redeploy your application to your environment: +1. Redeploy your application to your environment: ```bash rad deploy ./app.bicep @@ -190,7 +190,7 @@ This step requires an Azure subscription or an AWS account to deploy cloud resou db Applications.Datastores/redisCaches ``` -5. Use the az CLI to see your newly deployed Azure Cache for Redis: +1. Use the az CLI to see your newly deployed Azure Cache for Redis: ```bash az redis list --subscription "My Subscription" --query "[].name" diff --git a/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md b/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md index 0cb2f4f6d..e5af7e5f0 100644 --- a/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md +++ b/docs/shared-content/installation/vscode-bicep/install-vscode-bicep.md @@ -8,15 +8,15 @@ You can only have one VSCode Bicep extension installed at a time. To build on Ra Screenshot of Radius Bicep extension in VSCode Marketplace

-2. Select Install +1. Select Install To verify you've installed the extension, open any file with the .bicep file extension and start [authoring Radius application]({{< ref author-apps >}}) to verify the auto-complete and other validation features. {{< /latest >}} {{< edge >}} 1. Visit the [GitHub Actions runs](https://github.com/radius-project/bicep/actions/workflows/radius-build.yml?query=event%3Apush+branch%3Abicep-extensibility) -2. Click on the latest successful run -3. Scroll down to Artifacts and download `release` -4. Extract the archive and Install the `rad-vscode-bicep.vsix` file: +1. Click on the latest successful run +1. Scroll down to Artifacts and download `release` +1. Extract the archive and Install the `rad-vscode-bicep.vsix` file: In VSCode, manually install the extension using the *Install from VSIX* command in the Extensions view command drop-down. Screenshot of installing a vsix extension
@@ -28,6 +28,6 @@ To verify you've installed the extension, open any file with the .bicep file ext ``` If you're on macOS, make sure to [setup the `code` alias](https://code.visualstudio.com/docs/setup/mac#_launching-from-the-command-line). -5. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well:
+1. If running on Windows Subsystem for Linux (WSL), make sure to install the extension in WSL as well:
Screenshot of installing a vsix extension in WSL {{< /edge >}}