Skip to content

Commit 1f0fc04

Browse files
Refactor links to bottom of markdown
1 parent 271528d commit 1f0fc04

File tree

11 files changed

+146
-59
lines changed

11 files changed

+146
-59
lines changed

.devcontainer/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ You can monitor prebuild status in several ways:
198198
- Click on "View all" to see prebuild status
199199

200200
2. **Codespaces Settings**:
201-
- Visit [github.com/codespaces](https://github.com/codespaces)
201+
- Visit [github.com/codespaces][github-codespaces]
202202
- Check the "Repository prebuilds" section
203203
- View build logs and status
204204

@@ -273,7 +273,7 @@ The `devcontainer.json` includes specific Jupyter settings to ensure proper kern
273273
]
274274
```
275275

276-
For more details on kernel configuration in VS Code, see: [VS Code Issue #130946](https://github.com/microsoft/vscode/issues/130946#issuecomment-1899389049)
276+
For more details on kernel configuration in VS Code, see: [VS Code Issue #130946][vscode-issue-130946]
277277

278278
## 🛠️ Troubleshooting
279279

@@ -386,3 +386,8 @@ When modifying the dev container setup:
386386
---
387387

388388
*This dev container configuration is optimized for Azure API Management samples development with fast startup times and comprehensive tooling support.*
389+
390+
391+
392+
[github-codespaces]: https://github.com/codespaces
393+
[vscode-issue-130946]: https://github.com/microsoft/vscode/issues/130946#issuecomment-1899389049

.vscode/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
## Fixing Pylance unresolved import warnings
22

3-
Follow [this documentation](https://github.com/microsoft/pylance-release/blob/main/TROUBLESHOOTING.md#unresolved-import-warnings).
3+
Follow [this documentation][pylance-troubleshooting].
4+
5+
6+
7+
[pylance-troubleshooting]: https://github.com/microsoft/pylance-release/blob/main/TROUBLESHOOTING.md#unresolved-import-warnings

README.md

Lines changed: 74 additions & 37 deletions
Large diffs are not rendered by default.

assets/diagrams/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# PlantUML Diagrams
22

33
This directory contains PlantUML diagrams for the Azure API Management architecture.
4-
Azure Symbols are on [GitHub](https://github.com/plantuml-stdlib/Azure-PlantUML/blob/master/AzureSymbols.md)
4+
Azure Symbols are on [GitHub][azure-symbols].
55

66
## Using PlantUML in VS Code
77

@@ -46,3 +46,7 @@ If you encounter issues with PlantUML:
4646
3. **Alternative Rendering**:
4747
- If local rendering fails, try using the PlantUML server:
4848
- Change "plantuml.render" setting to "PlantUMLServer"
49+
50+
51+
52+
[azure-symbols]: https://github.com/plantuml-stdlib/Azure-PlantUML/blob/master/AzureSymbols.md

infrastructure/afd-apim-pe/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,15 @@ Secure architecture that takes all traffic off the public Internet once Azure Fr
1313

1414
## ⚙️ Configuration
1515

16-
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
16+
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables][init-notebook-variables] section.
1717

1818
## ▶️ Execution
1919

2020
👟 **Expected *Run All* runtime: ~13 minutes**
2121

22-
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.
22+
1. Execute this lab's [Jupyter Notebook][infra-notebook] step-by-step or via _Run All_.
23+
24+
25+
26+
[init-notebook-variables]: ./create.ipynb#initialize-notebook-variables
27+
[infra-notebook]: ./create.ipynb

infrastructure/apim-aca/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,15 @@ This architecture secures API traffic by routing requests through Azure API Mana
1212

1313
## ⚙️ Configuration
1414

15-
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
15+
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables][init-notebook-variables] section.
1616

1717
## ▶️ Execution
1818

1919
👟 **Expected *Run All* runtime: ~5 minutes**
2020

21-
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.
21+
1. Execute this lab's [Jupyter Notebook][infra-notebook] step-by-step or via _Run All_.
22+
23+
24+
25+
[init-notebook-variables]: ./create.ipynb#initialize-notebook-variables
26+
[infra-notebook]: ./create.ipynb

infrastructure/simple-apim/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,15 @@ This architecture provides a basic API gateway using Azure API Management, suita
1111

1212
## ⚙️ Configuration
1313

14-
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables](./create.ipynb#initialize-notebook-variables) section.
14+
Adjust the `user-defined parameters` in this lab's Jupyter Notebook's [Initialize notebook variables][init-notebook-variables] section.
1515

1616
## ▶️ Execution
1717

1818
👟 **Expected *Run All* runtime: ~3 minutes**
1919

20-
1. Execute this lab's [Jupyter Notebook](./create.ipynb) step-by-step or via _Run All_.
20+
1. Execute this lab's [Jupyter Notebook][infra-notebook] step-by-step or via _Run All_.
21+
22+
23+
24+
[infra-notebook]: ./create.ipynb
25+
[init-notebook-variables]: ./create.ipynb#initialize-notebook-variables

samples/azure-maps/README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,11 @@ This lab sets up:
5050

5151
## ⚙️ Configuration
5252

53-
1. Decide which of the [Infrastructure Architectures](../../README.md#infrastructure-architectures) you wish to use.
54-
1. If the infrastructure _does not_ yet exist, navigate to the desired [infrastructure](../../infrastructure/) folder and follow its README.md.
55-
1. If the infrastructure _does_ exist, adjust the `user-defined parameters` in the _Initialize notebook variables_ below. Please ensure that all parameters match your infrastructure.
53+
1. Decide which of the [Infrastructure Architectures][infrastructure-architectures] you wish to use.
54+
1. If the infrastructure _does not_ yet exist, navigate to the desired [infrastructure][infrastructure-folder] folder and follow its README.md.
55+
1. If the infrastructure _does_ exist, adjust the `user-defined parameters` in the _Initialize notebook variables_ below. Please ensure that all parameters match your infrastructure.
56+
57+
58+
59+
[infrastructure-architectures]: ../../README.md#infrastructure-architectures
60+
[infrastructure-folder]: ../../infrastructure/

samples/general/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Sets up a simple APIM instance with a variety of policies to experiment.
88

99
## 🎯 Objectives
1010

11-
1. Experience a variety of policies in any of the infrastructure architectures. You may see several examples from our [APIM policy snippets repo](https://github.com/Azure/api-management-policy-snippets).
11+
1. Experience a variety of policies in any of the infrastructure architectures. You may see several examples from our [APIM policy snippets repo][apim-policy-snippets].
1212
1. Become proficient with how policies operate.
1313
1. Gain confidence in setting up and configuring policies appropriately.
1414

@@ -22,4 +22,8 @@ Sets up a simple APIM instance with a variety of policies to experiment.
2222
## ⚙️ Configuration
2323

2424
1. Decide which of the [Infrastructure Architectures](../../README.md#infrastructure-architectures) you wish to use.
25-
1. Press `Run All` in this sample's `create.ipynb` notebook.
25+
1. Press `Run All` in this sample's `create.ipynb` notebook.
26+
27+
28+
29+
[apim-policy-snippets]: https://github.com/Azure/api-management-policy-snippets

samples/oauth-3rd-party/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Samples: OAuth 2.0 with 3rd Party
22

3-
Sets up a 3rd party integration via [Azure API Management Credential Manager](https://learn.microsoft.com/azure/api-management/credentials-overview).
3+
Sets up a 3rd party integration via [Azure API Management Credential Manager][apim-credential-manager].
44

55
***This sample has prerequisites! Please follow the instructions below.***
66

@@ -19,7 +19,7 @@ Sets up a 3rd party integration via [Azure API Management Credential Manager](ht
1919

2020
## 📝 Scenario
2121

22-
We chose Spotify as it provides an extensive [REST API](https://developer.spotify.com/documentation/web-api) and has relatively generous limits on free API access. This makes for a relatively straight-forward experience for this sample.
22+
We chose Spotify as it provides an extensive [REST API][spotify-rest-api] and has relatively generous limits on free API access. This makes for a relatively straight-forward experience for this sample.
2323
Specifically, this sample uses Spotify's REST API to obtain information about its deep music and artist catalog. API Management is registered as an application in Spotify's applications with its own client ID and client secret for a given scope. This application is then set up as a generic OAuth 2.0 integration in Credential Manager.
2424
Furthermore, we build on the knowledge gained from the _AuthX_ and _AuthX-Pro_ samples to authentication callers and authorize their use of the Spotify integration.
2525

@@ -42,17 +42,17 @@ This sample requires a little bit of manual pre-work in order to create a high-f
4242

4343
### A Spotify Account
4444

45-
1. You can use your existing Spotify account or sign up for a new one [here](https://www.spotify.com/us/signup). Please ensure you adhere to Spotify's terms & conditions of use.
45+
1. You can use your existing Spotify account or sign up for a new one [here][spotify-signup]. Please ensure you adhere to Spotify's terms & conditions of use.
4646

4747
### A Spotify Application
4848

4949
In order for API Management to gain access to Spotify's API, we need to create an application that represents API Management.
5050

51-
1. Open or log into the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard).
51+
1. Open or log into the [Spotify Developer Dashboard][spotify-dashboard].
5252
1. Review and accept the _Spotify Developer Terms of Service_, if required.
5353
1. Proceed with verifying your email address, if required.
5454
1. If the Dashboard does not open immediately, select it from the menu after clicking on your profile name (top-right corner).
55-
1. [Create the app](https://developer.spotify.com/dashboard/create):
55+
1. [Create the app][spotify-create-app]:
5656
- **App Name**: _APIM_
5757
- **App Description**: _API Management_
5858
- **Redirect URIs**: https://localhost:8080/callback
@@ -64,4 +64,13 @@ In order for API Management to gain access to Spotify's API, we need to create a
6464

6565
## Acknowledgement
6666

67-
We thank [Spotify](https://www.spotify.com) for access to their API. Keep building great products!
67+
We thank [Spotify][spotify] for access to their API. Keep building great products!
68+
69+
70+
71+
[apim-credential-manager]: https://learn.microsoft.com/azure/api-management/credentials-overview
72+
[spotify]: https://www.spotify.com
73+
[spotify-create-app]: https://developer.spotify.com/dashboard/create
74+
[spotify-dashboard]: https://developer.spotify.com/dashboard
75+
[spotify-rest-api]: https://developer.spotify.com/documentation/web-api
76+
[spotify-signup]: https://www.spotify.com/signup

0 commit comments

Comments
 (0)