updated structure for consistency and added canonical urls when missi…

…ng (#176)
Azure · Feb 21, 2025 · f5bf69f · f5bf69f
1 parent 9cdd573
commit f5bf69f
Show file tree

Hide file tree

Showing 25 changed files with 82 additions and 9 deletions.
diff --git a/docs/aca/00-workshop-intro/1-aca-core-components.md b/docs/aca/00-workshop-intro/1-aca-core-components.md
@@ -1,4 +1,8 @@
 ---
+title: ACA Core Components Overview
+parent: Workshop Introduction
+has_children: false
+nav_order: 1
 canonical_url: https://bitoftech.net/2022/08/25/tutorial-building-microservice-applications-azure-container-apps-dapr/
 ---
 

diff --git a/docs/aca/00-workshop-intro/2-scenario-architecture.md b/docs/aca/00-workshop-intro/2-scenario-architecture.md
@@ -1,4 +1,8 @@
 ---
+title: Scenario and Solution Architecture
+parent: Workshop Introduction
+has_children: false
+nav_order: 2
 canonical_url: https://bitoftech.net/2022/08/25/tutorial-building-microservice-applications-azure-container-apps-dapr/
 ---
 

diff --git a/docs/aca/00-workshop-intro/4-prerequisites.md b/docs/aca/00-workshop-intro/4-prerequisites.md
@@ -3,6 +3,7 @@ title: Prerequisites
 parent: Workshop Introduction
 has_children: false
 nav_order: 4
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
 ---
 
 ## Prerequisites

diff --git a/docs/aca/00-workshop-intro/index.md b/docs/aca/00-workshop-intro/index.md
@@ -1,6 +1,6 @@
 ---
-canonical_url: 'https://bitoftech.net/2022/08/25/tutorial-building-microservice-applications-azure-container-apps-dapr/'
 title: Introduction
+canonical_url: 'https://bitoftech.net/2022/08/25/tutorial-building-microservice-applications-azure-container-apps-dapr/'
 ---
 
 ## Description

diff --git a/docs/aca/01-deploy-api-to-aca/index.md b/docs/aca/01-deploy-api-to-aca/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: 'https://bitoftech.net/2022/08/25/deploy-microservice-application-azure-container-apps/'
+title: Deploy Backend API to ACA
 ---
 
 # Module 1 - Deploy Backend API to ACA

diff --git a/docs/aca/02-aca-comm/index.md b/docs/aca/02-aca-comm/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/08/25/communication-microservices-azure-container-apps/
+title: Communication Between Microservices in ACA
 ---
 
 # Module 2 - Communication Between Microservices in ACA

diff --git a/docs/aca/03-aca-dapr-integration/index.md b/docs/aca/03-aca-dapr-integration/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/08/29/dapr-integration-with-azure-container-apps/
+title: Dapr Integration with ACA
 ---
 
 # Module 3 - Dapr Integration with ACA

diff --git a/docs/aca/04-aca-dapr-stateapi/index.md b/docs/aca/04-aca-dapr-stateapi/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/08/29/azure-container-apps-state-store-with-dapr-state-management-api/
+title: ACA State Store with Dapr State Management API
 ---
 
 # Module 4 - ACA State Store With Dapr State Management API

diff --git a/docs/aca/05-aca-dapr-pubsubapi/index.md b/docs/aca/05-aca-dapr-pubsubapi/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/02/azure-container-apps-async-communication-with-dapr-pub-sub-api-part-6/
+title: ACA Async Communication with Dapr Pub/Sub API
 ---
 
 # Module 5 - ACA Async Communication with Dapr Pub/Sub API

diff --git a/docs/aca/06-aca-dapr-bindingsapi/index.md b/docs/aca/06-aca-dapr-bindingsapi/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/05/azure-container-apps-with-dapr-bindings-building-block/
+title: ACA with Dapr Bindings building block
 ---
 
 # Module 6 - ACA with Dapr Bindings Building Block

diff --git a/docs/aca/07-aca-cron-bindings/index.md b/docs/aca/07-aca-cron-bindings/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/05/azure-container-apps-with-dapr-bindings-building-block/
+title: ACA Scheduled Jobs with Dapr Cron Binding
 ---
 
 # Module 7 - ACA Scheduled Jobs with Dapr Cron Binding

diff --git a/docs/aca/08-aca-monitoring/index.md b/docs/aca/08-aca-monitoring/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/09/azure-container-apps-monitoring-and-observability-with-application-insights-part-8/
+title: ACA Monitoring and Observability with Application Insights
 ---
 
 # Module 8 - ACA Monitoring and Observability with Application Insights

diff --git a/docs/aca/09-aca-autoscale-keda/index.md b/docs/aca/09-aca-autoscale-keda/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/22/azure-container-apps-auto-scaling-with-keda-part-11/
+title: ACA Auto Scaling with KEDA
 ---
 
 # Module 9 - ACA Auto Scaling with KEDA

diff --git a/docs/aca/10-aca-iac-bicep/iac-bicep.md → docs/aca/10-aca-iac-bicep/01-iac-bicep.md b/docs/aca/10-aca-iac-bicep/iac-bicep.md → docs/aca/10-aca-iac-bicep/01-iac-bicep.md
@@ -1,4 +1,8 @@
 ---
+title: Deploy Infrastructure using Bicep
+parent: Module 10 - Deployment Via Bicep and DevOps
+has_children: false
+nav_order: 1
 canonical_url: https://bitoftech.net/2022/09/16/use-bicep-to-deploy-dapr-microservices-apps-to-azure-container-apps-part-10/
 ---
 
@@ -8,7 +12,7 @@ canonical_url: https://bitoftech.net/2022/09/16/use-bicep-to-deploy-dapr-microse
     30 minutes
 
 !!! note
-    If you're not interested in manually deploying the Bicep files or creating the container registry yourself, and prefer not to delve into the details of how they work, then you can skip this section and head directly to either [Deploy Infrastructure Using Github Actions](../../aca/10-aca-iac-bicep/ci-cd-git-action.md) or [Deploy Infrastructure Using Azure DevOps](../../aca/10-aca-iac-bicep/ci-cd-azdo.md) depending on your DevOps tool of choice.
+    If you're not interested in manually deploying the Bicep files or creating the container registry yourself, and prefer not to delve into the details of how they work, then you can skip this section and head directly to either [Deploy Infrastructure Using Github Actions](../../aca/10-aca-iac-bicep/02-ci-cd-git-action.md) or [Deploy Infrastructure Using Azure DevOps](../../aca/10-aca-iac-bicep/03-ci-cd-azdo.md) depending on your DevOps tool of choice.
 
 To begin, we need to define the Bicep modules that will be required to generate the Infrastructure code. Our goal for this module is to have a freshly created resource group that encompasses all the necessary resources and configurations - such as connection strings, secrets, environment variables, and Dapr components - which we utilized to construct our solution. By the end, we will have a new resource group that includes the following resources.
 

diff --git a/.../aca/10-aca-iac-bicep/ci-cd-git-action.md → ...a/10-aca-iac-bicep/02-ci-cd-git-action.md b/.../aca/10-aca-iac-bicep/ci-cd-git-action.md → ...a/10-aca-iac-bicep/02-ci-cd-git-action.md
@@ -1,10 +1,17 @@
+---
+title: Deploy Infrastructure using Bicep via GitHub Actions
+parent: Module 10 - Deployment Via Bicep and DevOps
+has_children: false
+nav_order: 2
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+---
 
 # Deploy Infrastructure Using GitHub Actions
 
 !!! info "Module Duration"
     30 minutes
 
-In the [previous section](../../aca/10-aca-iac-bicep/iac-bicep.md), we demonstrated how Bicep scripts can be used to automate the deployment of infrastructure components. However, creating the container registry and deploying the Bicep scripts using the Azure CLI still required manual effort. For a more efficient and streamlined process, it's preferable to use automation. GitHub Actions is a great solution for automating workflows, and in this section, we'll explain how to create a GitHub Action workflow for deploying the infrastructure components of our application.
+In the [previous section](../../aca/10-aca-iac-bicep/01-iac-bicep.md), we demonstrated how Bicep scripts can be used to automate the deployment of infrastructure components. However, creating the container registry and deploying the Bicep scripts using the Azure CLI still required manual effort. For a more efficient and streamlined process, it's preferable to use automation. GitHub Actions is a great solution for automating workflows, and in this section, we'll explain how to create a GitHub Action workflow for deploying the infrastructure components of our application.
 
 The workshop repository contains a GitHub Action workflow file that will be used to deploy the infrastructure components of our application. Follow the steps below to create a GitHub Action workflow to deploy the infrastructure components of our application.
 

diff --git a/docs/aca/10-aca-iac-bicep/ci-cd-azdo.md → docs/aca/10-aca-iac-bicep/03-ci-cd-azdo.md b/docs/aca/10-aca-iac-bicep/ci-cd-azdo.md → docs/aca/10-aca-iac-bicep/03-ci-cd-azdo.md
@@ -1,10 +1,17 @@
+---
+title: Deploy infrastructure using Azure Devops Pipeline
+parent: Module 10 - Deployment Via Bicep and DevOps
+has_children: false
+nav_order: 3
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+---
 
 # Deploy Infrastructure Using Azure DevOps
 
 !!! info "Module Duration"
     30 minutes
 
-In the [previous section](../../aca/10-aca-iac-bicep/iac-bicep.md), we demonstrated how Bicep scripts can be used to automate the deployment of infrastructure components. However, creating the container registry and deploying the Bicep scripts using the Azure CLI still required manual effort. For a more efficient and streamlined process, it's preferable to use automation. Azure DevOps is a great solution for automating workflows, and in this section, we'll explain how to create a Azure DevOps pipeline for deploying the infrastructure components of our application.
+In the [previous section](../../aca/10-aca-iac-bicep/01-iac-bicep.md), we demonstrated how Bicep scripts can be used to automate the deployment of infrastructure components. However, creating the container registry and deploying the Bicep scripts using the Azure CLI still required manual effort. For a more efficient and streamlined process, it's preferable to use automation. Azure DevOps is a great solution for automating workflows, and in this section, we'll explain how to create a Azure DevOps pipeline for deploying the infrastructure components of our application.
 
 The workshop repository contains a Azure Devops Pipeline yaml file that will be used to deploy the infrastructure components of our application. Follow the steps below to create a devops pipeline to deploy the infrastructure components of our application.
 

diff --git a/docs/aca/10-aca-iac-bicep/index.md b/docs/aca/10-aca-iac-bicep/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: https://bitoftech.net/2022/09/16/use-bicep-to-deploy-dapr-microservices-apps-to-azure-container-apps-part-10/
+title: Deployment via Bicep and DevOps
 ---
 
 # Module 10 - Deployment Via Bicep and DevOps

diff --git a/docs/aca/11-aca-landing-zone/index.md b/docs/aca/11-aca-landing-zone/index.md
@@ -1,3 +1,8 @@
+---
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+title: Integration with Azure Container Apps landing zone accelerator
+---
+
 # Module 11 - Integration with Azure Container Apps landing zone accelerator
 
 Azure landing zone accelerators provide architectural guidance, reference architectures, reference implementations, and automation to deploy workload platforms on Azure at scale. They are aligned with industry proven practices, such as those presented in Azure landing zones guidance in the Cloud Adoption Framework.

diff --git a/docs/aca/12-optimize-containers/index.md b/docs/aca/12-optimize-containers/index.md
@@ -1,5 +1,6 @@
 ---
 canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+title: Container optimization
 ---
 
 # Module 12 - Container Optimization

diff --git a/docs/aca/29-about-the-authors/index.md b/docs/aca/29-about-the-authors/index.md
@@ -1,3 +1,8 @@
+---
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+title: About the Authors
+---
+
 # Authors
 
 ### [:material-github: Taiseer Joudeh](https://github.com/tjoudeh){target=_blank}

diff --git a/docs/aca/30-appendix/01-run-debug-dapr-app-vscode.md b/docs/aca/30-appendix/01-run-debug-dapr-app-vscode.md
@@ -1,3 +1,11 @@
+---
+title: Debug and Launch Dapr Applications in VSCode
+parent: Appendix
+has_children: false
+nav_order: 1
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+---
+
 This page shows you how to configure VSCode to run and debug multiple Dapr applications at same time.
 
 ### Debug and launch Dapr applications in VSCode

diff --git a/docs/aca/30-appendix/02-github-local-codespaces.md b/docs/aca/30-appendix/02-github-local-codespaces.md
@@ -1,3 +1,11 @@
+---
+title: Testing Changes Locally or with GitHub Codespaces
+parent: Appendix
+has_children: false
+nav_order: 2
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+---
+
 # Inner loop, testing your changes locally or using GitHub Codespaces
 
 - `docs/aca` folder , contains all the mark-down documentation files for all the modules

diff --git a/docs/aca/30-appendix/03-variables.md b/docs/aca/30-appendix/03-variables.md
@@ -1,3 +1,11 @@
+---
+title: Variables
+parent: Appendix
+has_children: false
+nav_order: 3
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
+---
+
 # Variables
 
 We declare numerous variables throughout this workshop. As these modules are lengthy, you will likely complete them over multiple sessions. However, as sessions are additive, they require previously-set variables.

diff --git a/docs/aca/30-appendix/04-troubleshooting.md b/docs/aca/30-appendix/04-troubleshooting.md
@@ -2,7 +2,8 @@
 title: Troubleshooting
 parent: Appendix
 has_children: false
-nav_order: 5
+nav_order: 4
+canonical_url: 'https://azure.github.io/aca-dotnet-workshop'
 ---
 
 ## Troubleshooting

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -20,11 +20,11 @@ nav:
   - Module 9 - ACA Auto Scaling with KEDA: aca/09-aca-autoscale-keda/index.md
   - Module 10 - Deployment Via Bicep and DevOps:
     - aca/10-aca-iac-bicep/index.md
-    - Deploy Infrastructure using Bicep: aca/10-aca-iac-bicep/iac-bicep.md
-    - Deploy Infrastructure using Bicep via GitHub Actions: aca/10-aca-iac-bicep/ci-cd-git-action.md
-    - Deploy infrastructure using Azure Devops Pipeline: aca/10-aca-iac-bicep/ci-cd-azdo.md
+    - Deploy Infrastructure using Bicep: aca/10-aca-iac-bicep/01-iac-bicep.md
+    - Deploy Infrastructure using Bicep via GitHub Actions: aca/10-aca-iac-bicep/02-ci-cd-git-action.md
+    - Deploy infrastructure using Azure Devops Pipeline: aca/10-aca-iac-bicep/03-ci-cd-azdo.md
   - Module 11 - Integration with Azure Container Apps landing zone accelerator: aca/11-aca-landing-zone/index.md
-  - Module 12 - Optimize Containers: aca/12-optimize-containers/index.md
+  - Module 12 - Container optimization: aca/12-optimize-containers/index.md
   - About The Authors: aca/29-about-the-authors/index.md
   - Appendix:
     - Debug and Launch Dapr Applications in VSCode: aca/30-appendix/01-run-debug-dapr-app-vscode.md