Commit 4668eddf authored by R. S.'s avatar R. S.

Fix documentation syntax errors based on comments from @drybjed.

parent 7f12a179
......@@ -203,7 +203,8 @@ Changed
- [debops.resources] Changed behaviour of used groups for templating. Now all
groups the host is in, will be used to search for template files.
Read the documentation about `resources__templates <https://docs.debops.org/en/master/ansible/roles/debops.resources/defaults-detailed.html#resources-templates>`_ for more information on templating with `debops`.
Read the documentation about :ref:`resources__ref_templates` for more details
on templating with `debops`.
Fixed
~~~~~
......@@ -258,9 +259,9 @@ Removed
playbook. The relevant inventory variables have been renamed, check the
:ref:`upgrade_notes` for details.
- The `resources__group_name` variable has been removed in favor of using
- The ``resources__group_name`` variable has been removed in favor of using
all the groups the current hosts is in. This change has been reflected in the
updated variable `resources__group_templates`.
updated variable ``resources__group_templates``.
`debops v0.8.0`_ - 2018-08-06
......
......@@ -101,14 +101,14 @@ resources__templates: [ '{{ resources__src + "templates/by-group/all" }}' ]
# ]]]
# .. envvar:: resources__group_templates [[[
#
# List of paths containing the directories of all the groups the current host is in, based on the content of `group_names`.
# List of paths containing the directories of all the groups the current host is in, based on the content of ``group_names``.
# See `Ansible - Playbooks Varibles <https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#accessing-information-about-other-hosts-with-magic-variables>`_.
#
# For example if the host `debian1` is member of `group-name1` and `group-name2`
# `debops` will then search all template files inside the directories placed here: :file:`ansible/resources/template/by-group/`.
# Resulting in: `[ "ansible/resources/template/by-group/group-name1", "ansible/resources/template/by-group/group-name3" ]`.
# For example if the host ``debian1`` is member of ``group-name1`` and ``group-name2``
# `debops.resources` will then search all template files inside the directories placed here: :file:`ansible/resources/templates/by-group/`.
# Resulting in: ``[ "ansible/resources/template/by-group/group-name1", "ansible/resources/template/by-group/group-name3" ]``.
#
# Read the documentation about `resources__templates <https://docs.debops.org/en/master/ansible/roles/debops.resources/defaults-detailed.html#resources-templates>`_ for more information on templating with `debops`.
# Read the documentation about :ref:`resources__ref_templates` for more details on templating with `debops.resources`.
resources__group_templates: '{{ group_names | map("regex_replace", "^(.*)$", resources__src + "templates/by-group/\1") | list }}'
# ]]]
......
......@@ -59,10 +59,9 @@ are performed; this means that you can put a file in the :file:`by-group/all/`
directory and then override it using a host-specific directory.
The groups directories are read in the order dictated by Ansible during inventory parsing.
See `Ansible - Playbooks Varibles<https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#accessing-information-about-other-hosts-with-magic-variables>`_
to learn about the variable `group_names`.
See `Ansible - Working with Inventory<https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#how-variables-are-merged>`_
for more information on how to use `ansible_group_priority` to change the merge order
See .. _`Ansible - Playbooks Variables`: https://docs.ansible.com/ansible/latest/user_guide/playbooks_variables.html#accessing-information-about-other-hosts-with-magic-variables
to learn about the ``group_names`` variable, and .. _`Ansible - Working with Inventory`: https://docs.ansible.com/ansible/latest/user_guide/intro_inventory.html#how-variables-are-merged
for more information on how to use ``ansible_group_priority`` to change the merge order
for groups of the same level (after the parent/child order is resolved).
Each directory structure starts at the root of the filesystem (:file:`/`), so
......
......@@ -132,14 +132,11 @@ Inventory variable changes
- The ``resources__group_name`` variable has been removed in favor of using
all the groups the current hosts is in. This change has been reflected in the
updated variable ``resources__group_templates``.
If you need to use a specific group update the ``resources__group_templates``
accordingly. Read the documentation about `resources__templates <https://docs.debops.org/en/master/ansible/roles/debops.resources/defaults-detailed.html#resources-templates>`_
for more information on templating with `debops`. Example:
.. code-block:: none
resources__group_templates: '{{ (resources__src + "templates/by-group/" + "special_group") | list }}'
updated variable :envvar:`resources__group_templates`.
If you need to use a specific group update the :envvar:`resources__group_templates`
accordingly.
Read the documentation about :ref:`resources__ref_templates` for more details on
templating with `debops.resources`.
Changes related to LXC containers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment