From 3beb4b2fc3fd42822520960bb531988575eec3fe Mon Sep 17 00:00:00 2001 From: Pierre Riteau Date: Thu, 25 Mar 2021 10:42:12 +0100 Subject: [PATCH] Document requirements for symlinks used by custom playbooks Change-Id: If51a715bc9f68fbf750baeecb0e8415178bb5641 --- doc/source/custom-ansible-playbooks.rst | 6 ++++++ doc/source/installation.rst | 2 ++ 2 files changed, 8 insertions(+) diff --git a/doc/source/custom-ansible-playbooks.rst b/doc/source/custom-ansible-playbooks.rst index bb1e25fce..394904c1f 100644 --- 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 -------------- diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 3be69426e..ba92554c2 100644 --- 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 ========================