From aaa763b7afe7f3ad571e63942cd0b2f654227c34 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 10 Jul 2023 13:48:05 +0200 Subject: [PATCH] Upgrade docs build stack --- docs/check.Dockerfile | 14 ++++++-------- docs/content/https/acme.md | 2 +- docs/content/migration/v1-to-v2.md | 4 ++-- docs/content/providers/docker.md | 2 ++ docs/scripts/verify.sh | 9 ++++----- 5 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/check.Dockerfile b/docs/check.Dockerfile index 92321d109..d33a46af3 100644 --- a/docs/check.Dockerfile +++ b/docs/check.Dockerfile @@ -1,7 +1,8 @@ -FROM alpine:3.14 as alpine +FROM alpine:3.18 as alpine RUN apk --no-cache --no-progress add \ build-base \ + gcompat \ libcurl \ libxml2-dev \ libxslt-dev \ @@ -13,8 +14,8 @@ RUN apk --no-cache --no-progress add \ ruby-json \ zlib-dev -RUN gem install nokogiri --version 1.13.3 --no-document -- --use-system-libraries -RUN gem install html-proofer --version 3.19.3 --no-document -- --use-system-libraries +RUN gem install nokogiri --version 1.15.3 --no-document -- --use-system-libraries +RUN gem install html-proofer --version 5.0.7 --no-document -- --use-system-libraries # After Ruby, some NodeJS YAY! RUN apk --no-cache --no-progress add \ @@ -22,12 +23,9 @@ RUN apk --no-cache --no-progress add \ nodejs \ npm -# To handle 'not get uid/gid' -RUN npm config set unsafe-perm true - RUN npm install --global \ - markdownlint@0.22.0 \ - markdownlint-cli@0.26.0 + markdownlint@0.29.0 \ + markdownlint-cli@0.35.0 # Finally the shell tools we need for later # tini helps to terminate properly all the parallelized tasks when sending CTRL-C diff --git a/docs/content/https/acme.md b/docs/content/https/acme.md index 1392092bb..f59142156 100644 --- a/docs/content/https/acme.md +++ b/docs/content/https/acme.md @@ -11,7 +11,7 @@ Automatic HTTPS You can configure Traefik to use an ACME provider (like Let's Encrypt) for automatic certificate generation. !!! warning "Let's Encrypt and Rate Limiting" - Note that Let's Encrypt API has [rate limiting](https://letsencrypt.org/docs/rate-limits). These last up to __one week__, and can not be overridden. + Note that Let's Encrypt API has [rate limiting](https://letsencrypt.org/docs/rate-limits). These last up to **one week**, and can not be overridden. When running Traefik in a container this file should be persisted across restarts. If Traefik requests new certificates each time it starts up, a crash-looping container can quickly reach Let's Encrypt's ratelimits. diff --git a/docs/content/migration/v1-to-v2.md b/docs/content/migration/v1-to-v2.md index 8d93e48f3..849f42b4c 100644 --- a/docs/content/migration/v1-to-v2.md +++ b/docs/content/migration/v1-to-v2.md @@ -23,7 +23,7 @@ feature by feature, of how the configuration looked like in v1, and how it now l - convert `acme.json` file from v1 to v2 format. - migrate the static configuration contained in the file `traefik.toml` to a Traefik v2 file. -## Frontends and Backends Are Dead...
... Long Live Routers, Middlewares, and Services +## Frontends and Backends Are Dead, Long Live Routers, Middlewares, and Services During the transition from v1 to v2, a number of internal pieces and components of Traefik were rewritten and reorganized. As such, the combination of core notions such as frontends and backends has been replaced with the combination of [routers](../routing/routers/index.md), [services](../routing/services/index.md), and [middlewares](../middlewares/overview.md). @@ -542,7 +542,7 @@ To apply a redirection: ## Strip and Rewrite Path Prefixes With the new core notions of v2 (introduced earlier in the section -["Frontends and Backends Are Dead... Long Live Routers, Middlewares, and Services"](#frontends-and-backends-are-dead-long-live-routers-middlewares-and-services)), +["Frontends and Backends Are Dead, Long Live Routers, Middlewares, and Services"](#frontends-and-backends-are-dead-long-live-routers-middlewares-and-services)), transforming the URL path prefix of incoming requests is configured with [middlewares](../middlewares/overview.md), after the routing step with [router rule `PathPrefix`](../routing/routers/index.md#rule). diff --git a/docs/content/providers/docker.md b/docs/content/providers/docker.md index a1472d245..50cfd2a2a 100644 --- a/docs/content/providers/docker.md +++ b/docs/content/providers/docker.md @@ -254,7 +254,9 @@ services: _Required, Default="unix:///var/run/docker.sock"_ + See the sections [Docker API Access](#docker-api-access) and [Docker Swarm API Access](#docker-api-access_1) for more information. + ??? example "Using the docker.sock" diff --git a/docs/scripts/verify.sh b/docs/scripts/verify.sh index 44835ce79..24eeb4271 100755 --- a/docs/scripts/verify.sh +++ b/docs/scripts/verify.sh @@ -17,12 +17,11 @@ find "${PATH_TO_SITE}" -type f -not -path "/app/site/theme/*" \ -name "*.html" -print0 \ | xargs -0 -r -P "${NUMBER_OF_CPUS}" -I '{}' \ htmlproofer \ - --check-html \ + --checks \ --check_external_hash \ - --alt_ignore="/traefikproxy-vertical-logo-color.svg/" \ - --http_status_ignore="0,500,501,503" \ - --file_ignore="/404.html/" \ - --url_ignore="/https://groups.google.com/a/traefik.io/forum/#!forum/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik/,/doc.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/,/www.akamai.com/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io\/traefik-mesh/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/www.namesilo.com/,/www.youtube.com/,/www.linode.com/,/www.alibabacloud.com/,/www.cloudxns.net/,/www.vultr.com/,/vscale.io/,/hetzner.com/,/docs.github.com/,/njal.la/,/www.wedos.com/,/www.reg.ru/,/www.godaddy.com/,/internetbs.net/" \ + --ignore_status_codes="0,500,501,503" \ + --ignore_files="/404.html/" \ + --ignore_urls="/https://groups.google.com\/a\/traefik.io\/forum\/#!forum\/security/,/localhost:/,/127.0.0.1:/,/fonts.gstatic.com/,/.minikube/,/github.com\/traefik\/traefik\/*edit*/,/github.com\/traefik\/traefik/,/doc.traefik.io/,/github\.com\/golang\/oauth2\/blob\/36a7019397c4c86cf59eeab3bc0d188bac444277\/.+/,/www.akamai.com/,/pilot.traefik.io\/profile/,/traefik.io/,/doc.traefik.io\/traefik-mesh/,/www.mkdocs.org/,/squidfunk.github.io/,/ietf.org/,/www.namesilo.com/,/www.youtube.com/,/www.linode.com/,/www.alibabacloud.com/,/www.cloudxns.net/,/www.vultr.com/,/vscale.io/,/hetzner.com/,/docs.github.com/,/njal.la/,/www.wedos.com/,/www.reg.ru/,/www.godaddy.com/,/internetbs.net/" \ '{}' 1>/dev/null ## HTML-proofer options at https://github.com/gjtorikian/html-proofer#configuration