Skip to content

Commit

Permalink
Fix documentation syntax problems
Browse files Browse the repository at this point in the history
  • Loading branch information
abadger committed Dec 16, 2014
1 parent 735c8d3 commit b74a023
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docsite/rst/YAMLSyntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docsite/rst/guide_aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
```````````````````````````
Expand Down
6 changes: 2 additions & 4 deletions docsite/rst/playbooks_best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docsite/rst/playbooks_startnstep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
`````````````
Expand All @@ -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
````
Expand Down
2 changes: 1 addition & 1 deletion docsite/rst/playbooks_variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit b74a023

Please sign in to comment.