Validate doc links in PR/CI (#6391)

* Create docs.yml * Update winui3_migration.md * Create .unbroken_exclusions * Update .unbroken_exclusions * Update docs.yml Co-authored-by: Stephen L Peters <[email protected]>
microsoft · Feb 28, 2022 · 38a0f01 · 38a0f01
1 parent 212f038
commit 38a0f01
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,31 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Validate doc links
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: windows-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      # Runs a single command using the runners shell
+      - name: Check links
+        run: npx unbroken
+        working-directory: docs
diff --git a/docs/.unbroken_exclusions b/docs/.unbroken_exclusions
@@ -0,0 +1,2 @@
+URL not found https://microsoft.sharepoint.com/teams/FabricBot/SitePages/AutoMerge,-Bot-Templates-and.aspx while parsing contribution_workflow.md (HTTP 403)
+URL not found https://fabric-cp.azurewebsites.net/bot/ while parsing triage.md (HTTP 403)
diff --git a/docs/winui3_migration.md b/docs/winui3_migration.md
@@ -1,7 +1,7 @@
 # Migrating a UWP App To WinUI3
 
-**It is recommended to use the [try-convert](https://github.com/dotnet/try-convert/tree/feature/winui) tool for the full conversion process.**
-**try-convert will automate most of the conversion steps.**
+**It is recommended to use the  [try-convert](https://github.com/dotnet/try-convert/tree/feature/winui) tool for the full conversion process.**
+**`try-convert` will automate most of the conversion steps.**
 
 ## Background
 
@@ -18,4 +18,5 @@ This porting assistance is provided in the form of Roslyn Analyzers and Code Fix
 - A Code Analyzer provides on the fly code inspections for C# and creates diagnostics. 
 - A Code Fix consumes the diagnostics created by the Code Analyzer and modifies the C# file in-line. 
 
-See the [try-convert documentation](https://github.com/dotnet/try-convert/blob/feature/winui/WinUIConvert.md) for more information on these code analyzers and how to automoate the process with try-convert.
+See the [try-convert documentation](https://github.com/dotnet/try-convert/tree/feature/winui) for more information on these code analyzers and how to automoate the process with [try-convert](https://github.com/dotnet/try-convert/blob/feature/winui/WinUIConvert.md).
+