j40-cejst-2/.github/workflows/markdown-link-check.yml

name: Check Markdown links
on:
  pull_request:
    # The branches below must be a subset of the branches above
    branches: [ main ]
    # Run only if the pull request changes a markdown file:
    # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths
    paths:
      - '**.md'
jobs:
  markdown-link-check:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: gaurav-nelson/github-action-markdown-link-check@v1
Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation 2021-12-16 10:16:28 -05:00			`name: Check Markdown links`
			`on:`
			`pull_request:`
Run markdown link checker only on markdown changes (#1117) * Run markdown link checker only on markdown changes This makes sure that this action only runs if the pull request is on the main branch and is changing markdown files. Fixes: https://github.com/usds/justice40-tool/issues/1114 * Remove push to main trigger * Ignore eeoc.gov in link checker Sometimes it seems down from the perspective of github actions. 2022-01-12 13:01:52 -05:00			`# The branches below must be a subset of the branches above`
			`branches: [ main ]`
			`# Run only if the pull request changes a markdown file:`
			`# https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths`
			`paths:`
			`- '**.md'`
Update documentation to make it easier for users to find the right content for them (#1016) * First pass of updating documentation for new users Trying to look at this from the perspective of someone new to the project, and create some pathways to make it easier for people to get to the content they are looking for. * Make it clear that docker is doing the setup * Link installation again from the main README * Add some docs about the github actions * Add markdown link check * Move git installation first * Add config for markdown link checker * Fix some links * Correct handling of repo root relative links * Fix broken links in data roadmap * Fix more broken links * Fix more links * Ignore link that's returning a 403 to the checker It actually works if you go in a browser. * Fix another broken link * Ignore more urls that don't work * Update the readme under docs * Add some more dataset links * More strongly call out the quickstart * Try to call out even more the quickstart link * Fix dead links * Add note about initialization time * Remove broken link from spanish install guide These will be updated later with a full translation 2021-12-16 10:16:28 -05:00			`jobs:`
			`markdown-link-check:`
			`runs-on: ubuntu-latest`
			`steps:`
			`- uses: actions/checkout@v2`
			`- uses: gaurav-nelson/github-action-markdown-link-check@v1`