From ebf02870fe5841e70f6937dad59838b899768c90 Mon Sep 17 00:00:00 2001
From: squidfunk <martin.donath@squidfunk.com>
Date: Wed, 20 Jul 2022 11:12:33 +0200
Subject: [PATCH] Added a note in GitHub Actions

---
 .github/workflows/documentation.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
index 90775b3e7..f426aca1a 100644
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -67,6 +67,10 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
         run: |
+          # Warning: please don't use this method when installing Insiders from
+          # CI! We have to do it this way in order to allow for overrides on our
+          # own documentation, but you should stick to the method we recommend
+          # in the publishing guide – see https://bit.ly/3zjdJtw
           git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
           pip install -e mkdocs-material-insiders
           cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml