Skip to content

Commit

Permalink
Add Markdown Link Checker (#150)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
jtracey93 authored Feb 15, 2022
1 parent 5268a43 commit 62450fe
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 9 deletions.
6 changes: 6 additions & 0 deletions .github/actions-config/mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"aliveStatusCodes": [
200,
203
]
}
21 changes: 20 additions & 1 deletion .github/workflows/code-review.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ on:
###############
jobs:

build:
lint:
name: Lint code base
runs-on: ubuntu-latest

Expand All @@ -40,3 +40,22 @@ jobs:
VALIDATE_MARKDOWN: true
VALIDATE_POWERSHELL: true
VALIDATE_YAML: true

markdown-link-check:
name: Markdown Link Check
runs-on: ubuntu-latest

steps:

- name: Checkout code
uses: actions/checkout@master
with:
fetch-depth: 0

- name: Check links in markdown files
uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/actions-config/mlc_config.json'
use-verbose-mode: 'yes'
use-quiet-mode: 'yes'

2 changes: 1 addition & 1 deletion docs/wiki/CustomerUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Telemetry Tracking Using Customer Usage Attribution (PID)
<!-- markdownlint-restore -->

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).
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).

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.

Expand Down
12 changes: 6 additions & 6 deletions docs/wiki/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Wiki Navigation

* [Wiki Home](./Home)
* [Deployment Flow](./DeploymentFlow)
* [Contributing](./Contributing)
* [Telemetry Tracking Using Customer Usage Attribution (PID)](./CustomerUsage)
* [Azure Container Registry Deployment - Private Bicep Registry](./ACRDeployment)
* [Frequently Asked Questions](./FAQ)
* [Wiki Home](https://github.com/Azure/ALZ-Bicep/wiki/Home)
* [Deployment Flow](https://github.com/Azure/ALZ-Bicep/wiki/DeploymentFlow)
* [Contributing](https://github.com/Azure/ALZ-Bicep/wiki/Contributing)
* [Telemetry Tracking Using Customer Usage Attribution (PID)](https://github.com/Azure/ALZ-Bicep/wiki/CustomerUsage)
* [Azure Container Registry Deployment - Private Bicep Registry](https://github.com/Azure/ALZ-Bicep/wiki/ACRDeployment)
* [Frequently Asked Questions](https://github.com/Azure/ALZ-Bicep/wiki/FAQ)
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Module: PID

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')
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)

This module does not deploy any resources

Expand Down

0 comments on commit 62450fe

Please sign in to comment.