Skip to content

Commit

Permalink
Fix docs (#166)
Browse files Browse the repository at this point in the history
* Fix x-platform local docs and broken links

* Link to rather than render the ACA LZA
  • Loading branch information
simonkurtz-MSFT authored Nov 13, 2024
1 parent c61e6eb commit 74d293f
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 9 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,5 @@ build-docs-website:
cp -R site/* dist/

docs-local:
docker pull squidfunk/mkdocs-material:latest
docker build -t squidfunk/mkdocs-material:latest ./docs/
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
docker run --rm -it -p 8000:8000 -v $(CURDIR):/docs squidfunk/mkdocs-material
7 changes: 5 additions & 2 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-git-revision-date-plugin mkdocs-macros-plugin
RUN pip install mkdocs-glightbox

RUN pip install mkdocs-git-revision-date-plugin \
mkdocs-macros-plugin \
mkdocs-glightbox

2 changes: 1 addition & 1 deletion docs/aca/05-aca-dapr-pubsubapi/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ az containerapp env dapr-component set `
### 5. Configure Managed Identities for Both Container Apps
In the previous module we have [already configured](../04-aca-dapr-stateapi/index.md#configure-managed-identities-in-container-app) and used system-assigned identity for the Backend API container app. We follow the same steps here to create an association between the backend processor container app and Azure Service Bus.
In the previous module we have [already configured](../04-aca-dapr-stateapi/index.md#33-configure-managed-identities-in-container-app) and used system-assigned identity for the Backend API container app. We follow the same steps here to create an association between the backend processor container app and Azure Service Bus.
#### 5.1 Create system-assigned identity for Backend Processor App
Expand Down
2 changes: 1 addition & 1 deletion docs/aca/08-aca-monitoring/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The term *Telemetry* refers to the information gathered to monitor our applicati

1. Logging: provides insights into how code is executing and if errors have occurred.

In [module 1](../../aca/01-deploy-api-to-aca/index.md#2-deploy-web-api-backend-project-to-aca) we have already provisioned a Workspace-based Application Insights Instance and configured it for the ACA environment by setting the property `--dapr-instrumentation-key`. We presume that you have already set up an instance of Application Insights that is available for use across the three container apps.
In [module 1](../../aca/01-deploy-api-to-aca/index.md#3-deploy-web-api-backend-project-to-aca) we have already provisioned a Workspace-based Application Insights Instance and configured it for the ACA environment by setting the property `--dapr-instrumentation-key`. We presume that you have already set up an instance of Application Insights that is available for use across the three container apps.

### 2. Installing Application Insights SDK Into the Three Microservices Apps

Expand Down
3 changes: 1 addition & 2 deletions docs/aca/09-aca-autoscale-keda/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,6 @@ az containerapp update `
#### 4.1 Run an End-to-End Test and Generate Several Messages

Now we are ready to test out our Azure Service Bus Scaling Rule. To produce a high volume of messages, you can utilize the Service Bus Explorer located within your Azure Service Bus namespace. Navigate to Azure Service Bus, choose your topic/subscription, and then select the Service Bus Explorer option.

To get the number of current replicas of service `tasksmanager-backend-processor` we could run the command below, this should run single replica as we didn't load the service bus topic yet.
```shell
Expand Down Expand Up @@ -170,7 +169,7 @@ The message structure our backend processor expects is similar to the JSON shown
!!! success
If all is setup correctly, five replicas will be created based on the number of messages we generated into the topic. There are various ways to verify this:
* You can run the Azure CLI command used in [previous step](#3-run-an-end-to-end-test-and-generate-a-load-of-messages) to list the names of replicas.
* You can run the Azure CLI command used in [previous step](#41-run-an-end-to-end-test-and-generate-several-messages) to list the names of replicas.
* You can verify this from Container Apps `Console` tab where you will see those replicas in the drop-down list
![replica-console](../../assets/images/09-aca-autoscale-keda/replica-console.png)
Expand Down
2 changes: 1 addition & 1 deletion docs/aca/11-aca-landing-zone/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ It is recommended to deploy only the first four building blocks of the landing z

To have Dapr observability in Application Insights, you need to set the attributes `enableApplicationInsights` and `enableDaprInstrumentation` to `true` in the parameters file of the landing zone. To know more about monitoring and observability, you can follow this documentation [Operations management considerations for Azure Container Apps](https://github.com/Azure/aca-landing-zone-accelerator/blob/main/docs/design-areas/management.md){target=_blank}.

--8<-- "https://raw.githubusercontent.com/Azure/aca-landing-zone-accelerator/main/scenarios/aca-internal/bicep/sample-apps/dotnet-task-tracker-service/docs/02-container-apps.md"
Please see the [Azure Container Apps Landing Zone Accelerator Task Tracker Service](https://github.com/Azure/aca-landing-zone-accelerator/blob/main/scenarios/aca-internal/bicep/sample-apps/dotnet-task-tracker-service/docs/02-container-apps.md) for details as to how to deploy the container apps.

0 comments on commit 74d293f

Please sign in to comment.