From b74a02301bd65264c681c267fa8396585541d327 Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Tue, 16 Dec 2014 12:25:41 -0800 Subject: [PATCH] Fix documentation syntax problems --- docsite/rst/YAMLSyntax.rst | 2 +- docsite/rst/guide_aws.rst | 2 +- docsite/rst/playbooks_best_practices.rst | 6 ++---- docsite/rst/playbooks_startnstep.rst | 4 ++-- docsite/rst/playbooks_variables.rst | 2 +- 5 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docsite/rst/YAMLSyntax.rst b/docsite/rst/YAMLSyntax.rst index 9e5ef311035..4b85ebac30d 100644 --- a/docsite/rst/YAMLSyntax.rst +++ b/docsite/rst/YAMLSyntax.rst @@ -25,7 +25,7 @@ Ansible or not) should begin with ``---``. This is part of the YAML format and indicates the start of a document. All members of a list are lines beginning at the same indentation level starting -with a ``- `` (dash and whitespace) character:: +with a ``"- "`` (dash and whitespace) character:: --- # A list of tasty fruits diff --git a/docsite/rst/guide_aws.rst b/docsite/rst/guide_aws.rst index c91c6478e96..2daf8ec27ec 100644 --- a/docsite/rst/guide_aws.rst +++ b/docsite/rst/guide_aws.rst @@ -223,7 +223,7 @@ Generally speaking, we find most users using Packer. If you do not want to adopt Packer at this time, configuring a base-image with Ansible after provisioning (as shown above) is acceptable. -.. aws_next_steps:: +.. _aws_next_steps: Next Steps: Explore Modules ``````````````````````````` diff --git a/docsite/rst/playbooks_best_practices.rst b/docsite/rst/playbooks_best_practices.rst index cec48679ccf..43c642d583c 100644 --- a/docsite/rst/playbooks_best_practices.rst +++ b/docsite/rst/playbooks_best_practices.rst @@ -66,9 +66,7 @@ The top level of the directory would contain files and directories like so:: monitoring/ # "" fooapp/ # "" -.. note: If you find yourself having too many top level playbooks (for instance you have a playbook you wrote for a specific hotfix, etc), it may -make sense to have a playbooks/ directory instead. This can be a good idea as you get larger. If you do this, -configure your roles_path in ansible.cfg to find your roles location. +.. note: If you find yourself having too many top level playbooks (for instance you have a playbook you wrote for a specific hotfix, etc), it may make sense to have a playbooks/ directory instead. This can be a good idea as you get larger. If you do this, configure your roles_path in ansible.cfg to find your roles location. .. _use_dynamic_inventory_with_clouds: @@ -367,7 +365,7 @@ If group-specific settings are needed, this can also be done. For example:: In the above example, CentOS machines get the value of '42' for asdf, but other machines get '10'. This can be used not only to set variables, but also to apply certain roles to only certain systems. -Alternatively, if only variables are needed: +Alternatively, if only variables are needed:: - hosts: all tasks: diff --git a/docsite/rst/playbooks_startnstep.rst b/docsite/rst/playbooks_startnstep.rst index ac06962cf22..1067c3e1214 100644 --- a/docsite/rst/playbooks_startnstep.rst +++ b/docsite/rst/playbooks_startnstep.rst @@ -4,7 +4,7 @@ Start and Step This shows a few alternative ways to run playbooks. These modes are very useful for testing new plays or debugging. -.. _start_at_task +.. _start_at_task: Start-at-task ````````````` @@ -15,7 +15,7 @@ If you want to start executing your playbook at a particular task, you can do so The above will start executing your playbook at a task named "install packages". -.. _step +.. _step: Step ```` diff --git a/docsite/rst/playbooks_variables.rst b/docsite/rst/playbooks_variables.rst index 3a522613607..e198a454724 100644 --- a/docsite/rst/playbooks_variables.rst +++ b/docsite/rst/playbooks_variables.rst @@ -911,7 +911,7 @@ The contents of each variables file is a simple YAML dictionary, like this:: .. note:: It's also possible to keep per-host and per-group variables in very - similar files, this is covered in :doc:`intro_patterns`. + similar files, this is covered in :ref:`splitting_out_vars`. .. _passing_variables_on_the_command_line: