From 4c8db04d3da7bb38ed8651befa55656796caf63e Mon Sep 17 00:00:00 2001 From: Major Hayden Date: Tue, 21 Feb 2017 15:04:03 -0500 Subject: [PATCH] [Docs] Small cleanups to advanced config Change-Id: Ia5b00ea9398154609773704a58cefcddf9b449e8 --- .../draft-operations-guide/advanced-config.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/source/draft-operations-guide/advanced-config.rst b/doc/source/draft-operations-guide/advanced-config.rst index 786faa6ebd..f0d4ebadb5 100644 --- a/doc/source/draft-operations-guide/advanced-config.rst +++ b/doc/source/draft-operations-guide/advanced-config.rst @@ -277,12 +277,12 @@ Example task using the config_template module config_template: src: test.ini.j2 dest: /tmp/test.ini - config_overrides: {{ test_overrides }} + config_overrides: "{{ test_overrides }}" config_type: ini -Example overrides dictionary(hash) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Example overrides dictionary (hash) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: yaml @@ -291,8 +291,8 @@ Example overrides dictionary(hash) new_item: 12345 -Original template file test.ini.j2 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Original template file ``test.ini.j2`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: ini @@ -301,8 +301,8 @@ Original template file test.ini.j2 value2 = 123 -Rendered on disk file /tmp/test.ini -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Rendered on disk file ``/tmp/test.ini`` +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code-block:: ini @@ -314,7 +314,7 @@ Rendered on disk file /tmp/test.ini In this task the ``test.ini.j2`` file is a template which will be rendered and written to disk at ``/tmp/test.ini``. The **config_overrides** entry is a -dictionary(hash) which allows a deployer to set arbitrary data as overrides to +dictionary (hash) which allows a deployer to set arbitrary data as overrides to be written into the configuration file at run time. The **config_type** entry specifies the type of configuration file the module will be interacting with; available options are "yaml", "json", and "ini".