From 6c796c06ecc0fb641ad302c784822139c2d3807a Mon Sep 17 00:00:00 2001 From: squidfunk Date: Thu, 5 Dec 2024 17:13:20 +0100 Subject: [PATCH] Documentation --- docs/insiders/getting-started.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md index f0c7862cf..d2aa59f08 100644 --- a/docs/insiders/getting-started.md +++ b/docs/insiders/getting-started.md @@ -83,10 +83,10 @@ comfortable self-hosting: 5. [Create a new release] to build and publish the Docker image 6. Install [Pull App] on your fork to stay in-sync with upstream -The [`publish`][publish] workflow[^5] is automatically run when a new tag +The [`build`][build] workflow is automatically run when a new tag (release) is created. When a new Insiders version is released on the upstream repository, the [Pull App] will create a pull request with the changes and -pull in the new tag, which is picked up by the [`publish`][publish] workflow +pull in the new tag, which is picked up by the [`build`][build] workflow that builds and publishes the Docker image automatically to your private registry. @@ -116,12 +116,6 @@ outlined in the [Getting Started guide](../getting-started.md#with-docker). token created to access the Insiders repository, it's safer to create a dedicated token which you'll only use for publishing the Docker image. - [^5]: - The Insiders repository contains two GitHub Actions workflows: - - - `build.yml` – Build and lint the project (disabled on forks) - - `publish.yml` – Build and publish the Docker image - ### with git Of course, you can use Material for MkDocs Insiders directly from `git`: @@ -145,7 +139,7 @@ pip install -e mkdocs-material [GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository [Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release [Pull App]: https://github.com/apps/pull - [publish]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/publish.yml + [build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml ## Built-in plugins