Skip to content

Commit 6c796c0

Browse files
committed
Documentation
1 parent eab6959 commit 6c796c0

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

docs/insiders/getting-started.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ comfortable self-hosting:
8383
5. [Create a new release] to build and publish the Docker image
8484
6. Install [Pull App] on your fork to stay in-sync with upstream
8585

86-
The [`publish`][publish] workflow[^5] is automatically run when a new tag
86+
The [`build`][build] workflow is automatically run when a new tag
8787
(release) is created. When a new Insiders version is released on the upstream
8888
repository, the [Pull App] will create a pull request with the changes and
89-
pull in the new tag, which is picked up by the [`publish`][publish] workflow
89+
pull in the new tag, which is picked up by the [`build`][build] workflow
9090
that builds and publishes the Docker image automatically to your private
9191
registry.
9292

@@ -116,12 +116,6 @@ outlined in the [Getting Started guide](../getting-started.md#with-docker).
116116
token created to access the Insiders repository, it's safer to create a
117117
dedicated token which you'll only use for publishing the Docker image.
118118

119-
[^5]:
120-
The Insiders repository contains two GitHub Actions workflows:
121-
122-
- `build.yml` – Build and lint the project (disabled on forks)
123-
- `publish.yml` – Build and publish the Docker image
124-
125119
### with git
126120

127121
Of course, you can use Material for MkDocs Insiders directly from `git`:
@@ -145,7 +139,7 @@ pip install -e mkdocs-material
145139
[GitHub Actions secret]: https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository
146140
[Create a new release]: https://docs.github.com/en/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release
147141
[Pull App]: https://github.com/apps/pull
148-
[publish]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/publish.yml
142+
[build]: https://github.com/squidfunk/mkdocs-material-insiders/blob/master/.github/workflows/build.yml
149143

150144
## Built-in plugins
151145

0 commit comments

Comments
 (0)