From b209ab6fe10e09c632c66fad48edb78ef78377b5 Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Sat, 20 Jun 2020 04:40:39 +0200 Subject: [PATCH] Inject changelog in doc --- CHANGELOG.md | 6 +++--- Dockerfile.mkdocs | 1 + docs/changelog.md | 1 + docs/get-started.md | 3 --- mkdocs.yml | 3 +++ 5 files changed, 8 insertions(+), 6 deletions(-) create mode 100644 docs/changelog.md diff --git a/CHANGELOG.md b/CHANGELOG.md index e481f023..765a88b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## 3.0.0 (2020/05/27) -> :warning: See **Migration notes** in the documentation for breaking changes. +:warning: See **Migration notes** in the documentation for breaking changes. * Add script notification (#53) * Add Teams notification (#72) @@ -66,7 +66,7 @@ ## 2.0.0 (2019/12/14) -> :warning: See **Migration notes** in the documentation for breaking changes. +:warning: See **Migration notes** in the documentation for breaking changes. * Include provider in notifications * Add providers documentation @@ -121,7 +121,7 @@ ## 1.0.0 (2019/07/01) -> :warning: See **Migration notes** in the documentation for breaking changes. +:warning: See **Migration notes** in the documentation for breaking changes. * Always run on startup. Flag `--run-startup` removed. * Display next execution time diff --git a/Dockerfile.mkdocs b/Dockerfile.mkdocs index ffc851c2..9fc2b29a 100644 --- a/Dockerfile.mkdocs +++ b/Dockerfile.mkdocs @@ -7,6 +7,7 @@ RUN \ openssh \ && apk add --no-cache --virtual .build gcc musl-dev \ && pip install --no-cache-dir \ + 'markdown-include' \ 'mkdocs-macros-plugin' \ && apk del .build gcc musl-dev \ && rm -rf /tmp/* diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 00000000..09258822 --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1 @@ +{!../CHANGELOG.md!} diff --git a/docs/get-started.md b/docs/get-started.md index 82b44bcf..c5ec0791 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -4,9 +4,6 @@ [single executable](https://github.com/crazy-max/diun/releases/latest) (and a [Docker image](install/docker.md)) to receive notifications when a Docker image is updated on a Docker registry. -## Purpose - -The goal of this project is to provide the easiest, fastest, and most painless way of setting up a self-hosted service to handle this. With Go, this can be done with an independent binary distribution across all platforms and architectures that Go supports. This support includes Linux, macOS, and Windows, on architectures like amd64, i386, ARM, PowerPC, and others. diff --git a/mkdocs.yml b/mkdocs.yml index 03afcd38..58e642b4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -82,6 +82,7 @@ nav: - Kubernetes: providers/kubernetes.md - Swarm: providers/swarm.md - FAQ: faq.md + - Changelog: changelog.md - Migration: - Diun v2 to v3: migration/v2-to-v3.md - Diun v1 to v2: migration/v1-to-v2.md @@ -94,6 +95,8 @@ markdown_extensions: - admonition - codehilite - footnotes + - markdown_include.include: + base_path: docs - meta - pymdownx.details - pymdownx.tabbed