Skip to content

Commit

Permalink
Update doc dependencies and supported Python runtime to publish lates…
Browse files Browse the repository at this point in the history
…t doc updates (#8119)

* docs: Update doc dependencies and supported Python runtime

* fix: Correct link checking which seems to have been failing for quite some time
  • Loading branch information
bryantbiggs authored Jan 9, 2025
1 parent 626109d commit 738177d
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 26 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/exclude-file.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ weave-community.slack.com
netlify.com
slack.k8s.io
docs.google.com
groups.google.com
groups.google.com
gnu.org
24 changes: 9 additions & 15 deletions .github/workflows/link-checker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,38 +5,32 @@ on:
paths:
- 'userdocs/**'
- '**.md'
push:
branches:
- main
paths:
- 'userdocs/**'
- '**.md'

jobs:
link-checker:
name: Check site links
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.9]
steps:
- uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
- name: Set up Python ${{ matrix.python-version }}

- name: Set up Python
uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d #v5.1.0
with:
python-version: ${{ matrix.python-version }}
python-version: 3.12

- name: Setup Go
uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 #v5.0.0
with:
go-version: 1.21.x
cache: false

- name: Install doc dependencies
run: make install-site-deps

- name: Build docs for link check
run: make build-pages
# Using link-checker action to check links in Markdown, HTML files

- name: Link Checker
uses: lycheeverse/lychee-action@c053181aa0c3d17606addfe97a9075a32723548a #v1.9.3
uses: lycheeverse/lychee-action@f796c8b7d468feb9b8c0a46da3fac0af6874d374 #v2.2.0
with:
fail: true
args: --exclude-all-private --exclude-mail --exclude-file .github/workflows/exclude-file.txt --verbose --no-progress './**/*.md' './**/*.html'
args: --exclude-all-private --exclude-mail --exclude-file .github/workflows/exclude-file.txt --exclude-path goformation --verbose --no-progress './**/*.md' './**/*.html'
2 changes: 1 addition & 1 deletion userdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ extra_css:

extra_javascript:
- https://cdn.jsdelivr.net/npm/@glidejs/glide
- https://cdnjs.cloudflare.com/ajax/libs/axios/0.21.1/axios.min.js
- https://cdnjs.cloudflare.com/ajax/libs/axios/1.7.6/axios.min.js
- javascripts/extra.js

# Extensions
Expand Down
12 changes: 6 additions & 6 deletions userdocs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
mkdocs == 1.5.3
mkdocs-material == 9.5.17
mkdocs == 1.6.1
mkdocs-material == 9.5.49
mkdocs-redirects
mkdocs-minify-plugin
mkdocs-glightbox
pymdown-extensions >= 9.9.1
jinja2 == 3.1.4
pillow
jinja2 == 3.1.5
pillow
cairosvg

# Dependencies from material theme
# Dependencies from material theme
mkdocs-material-extensions>=1.1
pygments>=2.12
markdown>=3.2
markdown>=3.2
2 changes: 1 addition & 1 deletion userdocs/runtime.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3.8
3.12
4 changes: 2 additions & 2 deletions userdocs/src/usage/schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Modifications:
Copyright 2020 Weaveworks
*/

import { html, render } from "https://unpkg.com/lit-html@1.2.1/lit-html.js";
import { unsafeHTML } from "https://unpkg.com/lit-html@1.2.1/directives/unsafe-html.js";
import { html, render } from "https://unpkg.com/lit-html@3.2.1/lit-html.js";
import { unsafeHTML } from "https://unpkg.com/lit-html@3.2.1/directives/unsafe-html.js";

(async function () {
const table = document.getElementById("config");
Expand Down

0 comments on commit 738177d

Please sign in to comment.