From 46fe4d4b92a0b1e670c776f2d68d82fc4c9f9b56 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Fri, 4 Oct 2013 20:04:31 -0400 Subject: [PATCH] Fix some docs formatting. --- docsite/latest/rst/playbooks_best_practices.rst | 2 +- docsite/latest/rst/playbooks_roles.rst | 2 +- docsite/latest/rst/playbooks_variables.rst | 12 ++++++------ 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docsite/latest/rst/playbooks_best_practices.rst b/docsite/latest/rst/playbooks_best_practices.rst index 9be11f11a4..c0f349ff19 100644 --- a/docsite/latest/rst/playbooks_best_practices.rst +++ b/docsite/latest/rst/playbooks_best_practices.rst @@ -257,7 +257,7 @@ may be augmented by playbooks like 'deploy_exampledotcom.yml' but the general co Ansible allows you to deploy and configure using the same tool, so you would likely reuse groups and just keep the OS configuration in separate playbooks from the app deployment. -.. _stage_vs_prod: +.. _stage_vs_production: Stage vs Production +++++++++++++++++++ diff --git a/docsite/latest/rst/playbooks_roles.rst b/docsite/latest/rst/playbooks_roles.rst index 30da9ecb95..346ebffba0 100644 --- a/docsite/latest/rst/playbooks_roles.rst +++ b/docsite/latest/rst/playbooks_roles.rst @@ -28,7 +28,7 @@ more on the big picture and only dive down into the details when needed. We'll start with understanding includes so roles make more sense, but our ultimate goal should be understanding roles -- roles are great and you should use them every time you write playbooks. -See the `ansible-examples repository on github `_ for lots of examples of all of this +See the 'ansible-examples' repository on github for lots of examples of all of this put together. You may wish to have this open in a seperate tab as you dive in. Task Include Files And Encouraging Reuse diff --git a/docsite/latest/rst/playbooks_variables.rst b/docsite/latest/rst/playbooks_variables.rst index c041c1c1aa..22fed031a5 100644 --- a/docsite/latest/rst/playbooks_variables.rst +++ b/docsite/latest/rst/playbooks_variables.rst @@ -19,7 +19,7 @@ Once understanding variables you'll also want to dig into `playbooks_conditional Useful things like the "group_by" module and the "when" conditional can also be used with variables, and to help manage differences between systems. -It's highly recommended that you consult `the Ansible-Examples github repository `_ to see a lot of examples of variables put to use. +It's highly recommended that you consult the ansible-examples github repository to see a lot of examples of variables put to use. .. contents:: :depth: 2 @@ -114,14 +114,14 @@ Jinja2 Filters .. note: These are infrequently utilized features. Use them if they fit a use case you have, but this is optional knowledge. Filters in Jinja2 are a way of transforming template expressions from one kind of data into another. Jinja2 -ships with many of these as documented on `The official Jinja2 Templates Page `_. Scroll down and look for 'filters'. +ships with many of these as documented on the official Jinja2 template documentation. In addition to these, Ansible supplies many more. .. _filters_for_formatting_data Filters For Formatting Data -+++++++++++++++++++++++++++ +--------------------------- The following filters will take a data structure in a template and render it in a slightly different format. These are occasionally useful for debugging:: @@ -132,7 +132,7 @@ are occasionally useful for debugging:: .. _filters_used_with_conditionals: Filters Often Used With Conditionals -++++++++++++++++++++++++++++++++++++ +------------------------------------ The following tasks are illustrative of how filters can be used with conditionals:: @@ -157,7 +157,7 @@ The following tasks are illustrative of how filters can be used with conditional .. _forcing_variables_to_be_defined: Forcing Variables To Be Defined -+++++++++++++++++++++++++++++++ +------------------------------- The default behavior from ansible and ansible.cfg is to fail if variables are undefined, but you can turn this off. @@ -170,7 +170,7 @@ The variable value will be used as is, but the template evaluation will raise an .. _other_useful_filters: Other Useful Filters -++++++++++++++++++++ +-------------------- To get the last name of a file path, like 'foo.txt' out of '/etc/asdf/foo.txt'::