diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 728602e1..09cea5fb 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -30,10 +30,21 @@ jobs: curl -sSL $url | tar -xz --directory=./mdbook echo `pwd`/mdbook >> $GITHUB_PATH - - name: Deploy GitHub Pages + - name: Build Documentation run: | cd wiki mdbook build + + # mdBook rewrites .md links to .html without verifying the target exists, so a + # renamed or removed page builds cleanly and 404s in production. This also checks + # that the legacy wiki redirect map still resolves. + - name: Check Links + shell: pwsh + run: ./wiki/tools/Test-Links.ps1 -Book ./wiki/book -MapPath ./wiki/tools/wiki-redirect-map.tsv + + - name: Deploy GitHub Pages + run: | + cd wiki git worktree add gh-pages git config user.name "GitHub Pages from CI" git config user.email "" diff --git a/README.md b/README.md index 4c503c3f..2d11796c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)](https://dotnetfoundation.org/projects/project-detail/asp.net-api-versioning) +[![.NET Foundation](https://img.shields.io/badge/.NET%20Foundation-blueviolet.svg)][dnf] [![MIT License](https://img.shields.io/github/license/dotnet/aspnet-api-versioning?color=%230b0&style=flat-square)](https://github.com/dotnet/aspnet-api-versioning/blob/main/LICENSE.txt) [![Build Status](https://dev.azure.com/aspnet-api-versioning/build/_apis/build/status/dotnet.aspnet-api-versioning?branchName=main)](https://dev.azure.com/aspnet-api-versioning/build/_build/latest?definitionId=1&branchName=main) @@ -153,10 +153,12 @@ This project is licensed under the [MIT](LICENSE.TXT) license. ## .NET Foundation -[](https://dotnetfoundation.org/projects/aspnet-api-versioning) +[][dnf] This project is supported by the [.NET Foundation](https://dotnetfoundation.org). ---- > If you are an existing user, please makes sure you review the [release notes](../../releases) between all major and minor package releases.
Logo by Sacramento Design Works
+ +[dnf]: https://dotnetfoundation.org/projects/project-detail/asp.net-api-versioning \ No newline at end of file diff --git a/asp.slnx b/asp.slnx index ce62c5a2..a971d0ed 100644 --- a/asp.slnx +++ b/asp.slnx @@ -38,6 +38,7 @@ + diff --git a/dnf.svg b/dnf.svg new file mode 100644 index 00000000..5ac7d0ae --- /dev/null +++ b/dnf.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/wiki/tools/README.md b/wiki/tools/README.md new file mode 100644 index 00000000..43c313ac --- /dev/null +++ b/wiki/tools/README.md @@ -0,0 +1,99 @@ +# Wiki Tools + +Tooling for the legacy GitHub wiki, which was superseded by +. + +The wiki is intentionally kept online rather than disabled. Articles, training material, and +blog posts link to it, and those links should keep resolving. Every page has been replaced with +a short stub pointing at the equivalent page on the new site. + +## Why stubs instead of redirects + +GitHub wikis cannot issue an HTTP redirect. There is no `_redirects` or `.htaccess`, and +GitHub's Markdown sanitizer strips ``, `