Skip to content

Commit 62450fe

Browse files
authored
Add Markdown Link Checker (#150)
* add md link checker * updates following 1st run of link checker * typo * test fix for sidebar * test * test 2 * add quiet and verbose * fix typo and remove continue on error
1 parent 5268a43 commit 62450fe

File tree

5 files changed

+34
-9
lines changed

5 files changed

+34
-9
lines changed
+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"aliveStatusCodes": [
3+
200,
4+
203
5+
]
6+
}

.github/workflows/code-review.yml

+20-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ on:
1515
###############
1616
jobs:
1717

18-
build:
18+
lint:
1919
name: Lint code base
2020
runs-on: ubuntu-latest
2121

@@ -40,3 +40,22 @@ jobs:
4040
VALIDATE_MARKDOWN: true
4141
VALIDATE_POWERSHELL: true
4242
VALIDATE_YAML: true
43+
44+
markdown-link-check:
45+
name: Markdown Link Check
46+
runs-on: ubuntu-latest
47+
48+
steps:
49+
50+
- name: Checkout code
51+
uses: actions/checkout@master
52+
with:
53+
fetch-depth: 0
54+
55+
- name: Check links in markdown files
56+
uses: gaurav-nelson/github-action-markdown-link-check@v1
57+
with:
58+
config-file: '.github/actions-config/mlc_config.json'
59+
use-verbose-mode: 'yes'
60+
use-quiet-mode: 'yes'
61+

docs/wiki/CustomerUsage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Telemetry Tracking Using Customer Usage Attribution (PID)
33
<!-- markdownlint-restore -->
44

5-
Microsoft can identify the deployments of the Azure Resource Manager and Bicep templates with the deployed Azure resources. Microsoft can correlate these resources used to support the deployments. Microsoft collects this information to provide the best experiences with their products and to operate their business. The telemetry is collected through [customer usage attribution](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution). The data is collected and governed by Microsoft's privacy policies, located at the [trust center](https://www.microsoft.com/trustcentery).
5+
Microsoft can identify the deployments of the Azure Resource Manager and Bicep templates with the deployed Azure resources. Microsoft can correlate these resources used to support the deployments. Microsoft collects this information to provide the best experiences with their products and to operate their business. The telemetry is collected through [customer usage attribution](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution). The data is collected and governed by Microsoft's privacy policies, located at the [trust center](https://www.microsoft.com/trustcenter).
66

77
To disable this tracking, we have included a parameter called `parTelemetryOptOut` to every bicep module in this repo with a simple boolean flag. The default value `false` which **does not** disable the telemetry. If you would like to disable this tracking, then simply set this value to `true` and this module will not be included in deployments and **therefore disables** the telemetry tracking.
88

docs/wiki/_Sidebar.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Wiki Navigation
22

3-
* [Wiki Home](./Home)
4-
* [Deployment Flow](./DeploymentFlow)
5-
* [Contributing](./Contributing)
6-
* [Telemetry Tracking Using Customer Usage Attribution (PID)](./CustomerUsage)
7-
* [Azure Container Registry Deployment - Private Bicep Registry](./ACRDeployment)
8-
* [Frequently Asked Questions](./FAQ)
3+
* [Wiki Home](https://github.com/Azure/ALZ-Bicep/wiki/Home)
4+
* [Deployment Flow](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow)
5+
* [Contributing](https://github.com/Azure/ALZ-Bicep/wiki/Contributing)
6+
* [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/ALZ-Bicep/wiki/CustomerUsage)
7+
* [Azure Container Registry Deployment - Private Bicep Registry](https://github.com/Azure/ALZ-Bicep/wiki/ACRDeployment)
8+
* [Frequently Asked Questions](https://github.com/Azure/ALZ-Bicep/wiki/FAQ)

infra-as-code/bicep/CRML/customerUsageAttribution/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Module: PID
22

3-
This module creates a blank deployment which will be called from other modules. The purpose of this deployment is to create a deployment name to be used for Azure [customer usage attribution](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution). To disable this, please see [How to disable Telemetry Tracking Using Customer Usage Attribution (PID)]('../../../../docs/wiki/CustomerUsage.md')
3+
This module creates a blank deployment which will be called from other modules. The purpose of this deployment is to create a deployment name to be used for Azure [customer usage attribution](https://docs.microsoft.com/azure/marketplace/azure-partner-customer-usage-attribution). To disable this, please see [How to disable Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/ALZ-Bicep/wiki/CustomerUsage)
44

55
This module does not deploy any resources
66

0 commit comments

Comments
 (0)