docs icon indicating copy to clipboard operation
docs copied to clipboard

Docfx: Build Process -- run html-proofer or similar to check for dead links

Open SeanKilleen opened this issue 4 years ago • 1 comments

SeanKilleen avatar Jun 08 '20 11:06 SeanKilleen

#476 wasn't successful for html-proofer due to it hitting github and getting rate limited. I'd like us to be better internet citizens.

I think we can follow-up on this with another PR and perhaps ignore github issue and PR URLs. That should cut down on a ton of noise.

For what it's worth, here's the GitHub action job that worked:

html_proofer:
    name: HTML checks (FYI only)
    needs: [build]
    runs-on: ubuntu-latest
    steps:
    - name: Download site artifacts
      uses: actions/download-artifact@v2
      with:
        name: siteArtifact
    - name: unzip site contents
      run: unzip _site.zip
    - name: Check HTML
      uses: chabad360/htmlproofer@master
      with:
        directory: "./docs/_site/articles"
        arguments: --log-level debug

SeanKilleen avatar Jul 22 '20 02:07 SeanKilleen

I'm thinking that it probably makes sense to leave this for now. We fixed a bunch of links and I'm OK doing this as a periodic batch process rather than trying to get it into the build process, given the state of the ecosystem.

SeanKilleen avatar Oct 16 '23 01:10 SeanKilleen