Skip to content

Commit f16f81e

Browse files
author
Wael Kdouh
committed
Introduced some additional documentation refactoring.
1 parent d18bc94 commit f16f81e

13 files changed

Lines changed: 13 additions & 14 deletions

File tree

docs/aca/01-deploy-api-to-aca/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ We will be using Azure CLI to deploy the Web API Backend to ACA as shown in the
119119
--sku Basic `
120120
--admin-enabled true
121121
```
122-
???+ note
122+
!!! note
123123
Notice that we create the registry with admin rights `--admin-enabled` flag set to `true` which is not suited for real production, but good for our workshop.
124124
125125
- Create an Azure Log Analytics Workspace which will provide a common place to store the system and application log data from all container apps running in the environment. Each environment should have its own Log Analytics Workspace. To create it, run the command below:

docs/aca/03-aca-dapr-integration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ The SDK offers developers three ways of making remote service invocation calls:
182182
Notice how we assigned the Dapr App Id “tasksmanager-frontend-webapp” to the Frontend WebApp.
183183

184184
!!! note
185-
If you need to run both microservices together, you need to keep calling `dapr run` manually each time in the terminal. And when you have multiple microservices talking to each other you need to run at the same time to debug the solution. This can be a convoluted process. You can refer to the [debug and launch Dapr applications in VSCode](../../aca/20-appendix/01-run-debug-dapr-app-vscode.md) to see how to configure VScode for running and debugging Dapr applications.
185+
If you need to run both microservices together, you need to keep calling `dapr run` manually each time in the terminal. And when you have multiple microservices talking to each other you need to run at the same time to debug the solution. This can be a convoluted process. You can refer to the [debug and launch Dapr applications in VSCode](../../aca/12-appendix/01-run-debug-dapr-app-vscode.md) to see how to configure VScode for running and debugging Dapr applications.
186186

187187
!!! success
188188
Now both Applications are running using Dapr sidecar. Open your browser and browse for `https://localhost:{localwebappport}`. E.g. `https://localhost:7000` and provide an email to load the tasks for the user (e.g. tjoudeh@bitoftech.net).

docs/aca/04-aca-dapr-stateapi/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ To add the component file state store, add a new folder named **components** und
256256

257257
Now you should be ready to launch both applications and start doing CRUD operations from the Frontend Web App including querying the store. All your data will be stored in Cosmos DB Database you just provisioned.
258258

259-
If you have been running the different microservices using the [debug and launch Dapr applications in VSCode](../../aca/20-appendix/01-run-debug-dapr-app-vscode.md) then remember to uncomment the following line inside tasks.json file.
259+
If you have been running the different microservices using the [debug and launch Dapr applications in VSCode](../../aca/12-appendix/01-run-debug-dapr-app-vscode.md) then remember to uncomment the following line inside tasks.json file.
260260
This will instruct dapr to load the local projects components [./components](.) instead of the global components' folder.
261261

262262
```json hl_lines="2"

docs/aca/05-aca-dapr-pubsubapi/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ We want to have more control and provide our own component file, so let's create
3939
--8<-- "docs/aca/05-aca-dapr-pubsubapi/dapr-pubsub-redis.yaml"
4040
```
4141

42-
To try out the Pub/Sub API, run the Backend API from VS Code by running the below command or using the Run and Debug tasks we have created in the appendix [post](../../aca/20-appendix/01-run-debug-dapr-app-vscode.md).
42+
To try out the Pub/Sub API, run the Backend API from VS Code by running the below command or using the Run and Debug tasks we have created in the [appendix](../../aca/12-appendix/01-run-debug-dapr-app-vscode.md).
4343

4444
!!! note
4545
Don't forget to include the property `--resources-path`. Remember to replace the placeholders with your own values
@@ -263,7 +263,7 @@ in the terminal to indicate the processing of the message.
263263

264264
#### 6. Optional: Update VS Code Tasks and Launch Configuration Files
265265

266-
If you have followed the steps in the [appendix](../../aca/20-appendix/01-run-debug-dapr-app-vscode.md) so far in order to be able to run the three services together (frontend, backend api, and backend processor)
266+
If you have followed the steps in the [appendix](../../aca/12-appendix/01-run-debug-dapr-app-vscode.md) so far in order to be able to run the three services together (frontend, backend api, and backend processor)
267267
and debug them in VS Code, we need to update the files `tasks.json` and `launch.json` to include the new service we have added.
268268

269269
??? example "Click to expand the files to update"

docs/aca/06-aca-dapr-bindingsapi/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ Update and replace the code in the file with the code below. Pay close attention
188188
#### 6. Test Dapr Bindings Locally
189189

190190
Now we are ready to give it an end-to-end test on our dev machines. Run the 3 applications together using Debug and Run button from VS Code. You can read how we configured the 3 apps to run together
191-
in this [section](../../aca/20-appendix/01-run-debug-dapr-app-vscode.md).
191+
in this [section](../../aca/12-appendix/01-run-debug-dapr-app-vscode.md).
192192

193193
Open Azure Storage Explorer on your local machine. If you don't have it installed you can install it from [here](https://azure.microsoft.com/en-us/products/storage/storage-explorer/#overview).
194194
Login to your Azure Subscription and navigate to the storage account already created, create a queue, and use the same name you already used in the Dapr Input configuration file.

docs/aca/10-contributing/1-contribution-guide.md renamed to docs/aca/11-contributing/1-contribution-guide.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ If you'd like to contribute to this guide, please read the following guidelines.
44

55
- [Submit an issue or suggestion](2-Submit-issue-suggestion.md)
66
- [Minor update or fix to an existing challenge and adding a new challenge](3-minor-update-fix.md)
7-
- [Run the github page locally with GitHub Codespaces](4-github-local-codespaces.md)
87

98
# Contributing
109

File renamed without changes.
File renamed without changes.

docs/aca/20-appendix/01-run-debug-dapr-app-vscode.md renamed to docs/aca/12-appendix/01-run-debug-dapr-app-vscode.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ To accomplish this, open file `launch.json` and add the two configurations shown
2525
=== "launch.json"
2626

2727
```json
28-
--8<-- "docs/aca/20-appendix/launch.json"
28+
--8<-- "docs/aca/12-appendix/launch.json"
2929
```
3030
!!! note
3131
We have a `preLaunchTask` and a `postDebugTask` which we need to define right now. Those tasks are Dapr tasks.
@@ -44,7 +44,7 @@ Now we will add 4 tasks, for each application, there will be a task to support t
4444
=== "tasks.json"
4545

4646
```json
47-
--8<-- "docs/aca/20-appendix/tasks.json"
47+
--8<-- "docs/aca/12-appendix/tasks.json"
4848
```
4949

5050
??? tip "Curious to learn more about the tasks.json file above?"
File renamed without changes.

0 commit comments

Comments
 (0)