Document requirements for symlinks used by custom playbooks

Change-Id: If51a715bc9f68fbf750baeecb0e8415178bb5641
2021-03-25 10:42:12 +01:00 · 2021-03-25 10:42:12 +01:00 · 3beb4b2fc3
commit 3beb4b2fc3
parent 9934e86b0d
2 changed files with 8 additions and 0 deletions
--- a/doc/source/custom-ansible-playbooks.rst
+++ b/doc/source/custom-ansible-playbooks.rst
@ -66,6 +66,12 @@ plugins:

 These symlinks can even be committed to the kayobe-config Git repository.

+.. note::
+
+   These symlinks rely on having a kayobe source checkout at the same level as
+   the kayobe-config repository checkout, as described in
+   :ref:`installation-source`.
+
 Ansible Galaxy
 --------------

--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@ -109,6 +109,8 @@ Finally, deactivate the virtualenv::

    (kayobe) $ deactivate

+.. _installation-source:
+
 Installation from source
 ========================