Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
SeanKilleen opened this issue Jun 8, 2020 · 2 comments
Assignees
Labels
area:docfx Related to the docfx platform that we use to publish the docs

Comments

@SeanKilleen
Copy link
Member

No description provided.

@SeanKilleen SeanKilleen changed the title Docfx: Run html-proofer or similar to check for dead links Docfx: Build Process -- run html-proofer or similar to check for dead links Jun 8, 2020
@SeanKilleen SeanKilleen mentioned this issue Jun 8, 2020
50 tasks
@SeanKilleen SeanKilleen added the area:docfx Related to the docfx platform that we use to publish the docs label Jun 12, 2020
@SeanKilleen
Copy link
Member Author

#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
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docfx Related to the docfx platform that we use to publish the docs
Projects
None yet
Development

No branches or pull requests

1 participant