add GH Action to check links

simplify checking of links

fix some links

fail properly

Don't check docs directory twice

attempt fixing erroring out

update bits

update theme

don't check GH home

update theme

.github/workflows/check-links.yaml

@@ -0,0 +1,56 @@
+name: docs
+
+on:
+ pull_request:
+ push:
+ branches:
+ - master
+
+jobs:
+ markdown-link-checker:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+ - name: Install markdown-link-check
+ run: |
+ npm i markdown-link-check
+
+ - name: Check non-user-guide markdown docs
+ run: |
+ find . \
+ -name vendor -prune -o \
+ -name node_modules -prune -o \
+ -name docs -prune -o \
+ -iname '*.md' \
+ -exec ./node_modules/markdown-link-check/markdown-link-check -q --config .github/workflows/markdown-link-check-config.json {} +
+
+ site-link-checker:
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ python-version: [3.8]
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v1
+ with:
+ python-version: ${{ matrix.python-version }}
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install -r docs/requirements.txt
+
+ - name: Build docs for link check
+ run: mkdocs build
+
+ # Using liche action to check generated HTML site
+ - name: Link Checker (generated site)
+ id: lc2
+ uses: peter-evans/link-checker@v1
+ with:
+ args: -d site/ -r site/ -x 'github.com/weaveworks/ignite($|/issue|/pull)' -c 10
+
+ - name: Fail if there were link errors
+ run: exit ${{ steps.lc2.outputs.exit_code }}

.github/workflows/markdown-link-check-config.json

@@ -0,0 +1,6 @@
+{
+ "ignorePatterns": [
+ { "pattern": "^https://github.com/\\S+/\\S+/(issues|pull)/" },
+ { "pattern": "^mailto:" }
+ ]
+}

docs/requirements.txt

@@ -1,3 +1,3 @@
-mkdocs == 1.1
-mkdocs-material == 5.0.1
-pymdown-extensions >= 7.0.0
+mkdocs == 1.1.2
+mkdocs-material == 5.2.2
+pymdown-extensions >= 7.1

mkdocs.yml

@@ -28,6 +28,6 @@ markdown_extensions:
  - admonition
  - codehilite:
  guess_lang: false
- - pymdownx.superfences
+ - pymdownx.tabbed
  - toc:
  permalink: true