From 5d6deb68ae455670d26988d22daf0fbceaff5c20 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Sun, 29 Sep 2013 20:09:30 -0400 Subject: [PATCH] More work fixing doc links. --- docsite/latest/rst/index.rst | 12 ++++++++---- docsite/latest/rst/intro_dynamic_inventory.rst | 2 +- docsite/latest/rst/intro_getting_started.rst | 2 +- docsite/latest/rst/intro_installation.rst | 6 +++--- docsite/latest/rst/playbooks_best_practices.rst | 6 +++--- docsite/latest/rst/playbooks_conditionals.rst | 2 +- docsite/latest/rst/playbooks_roles.rst | 2 +- docsite/latest/rst/playbooks_variables.rst | 3 +-- 8 files changed, 19 insertions(+), 16 deletions(-) diff --git a/docsite/latest/rst/index.rst b/docsite/latest/rst/index.rst index 37e9076d053..9cb19ad3c48 100644 --- a/docsite/latest/rst/index.rst +++ b/docsite/latest/rst/index.rst @@ -31,6 +31,7 @@ An Introduction intro_dynamic_inventory intro_patterns intro_adhoc + intro_configuration modules Overview @@ -71,16 +72,20 @@ Advanced Topics In Playbooks Here are some playbook features that not everyone may need to learn, but can be quite useful for particular applications. Browsing these topics is recommended as you may find some useful tips here, but feel free to learn Ansible first and adopt -these only if they seem relevant or useful to your environment:: +these only if they seem relevant or useful to your environment. + +.. toctree:: + :maxdepth: 1 playbooks_acceleration - playbooks_check_mode + playbooks_async + playbooks_checkmode playbooks_delegation playbooks_environment playbooks_error_handling playbooks_lookups playbooks_prompts - playbooks_strategies + playbooks_tags Detailed Guides ``````````````` @@ -129,6 +134,5 @@ Miscellaneous :maxdepth: 1 faq - contrib glossary diff --git a/docsite/latest/rst/intro_dynamic_inventory.rst b/docsite/latest/rst/intro_dynamic_inventory.rst index 23489617f38..21a858e5049 100644 --- a/docsite/latest/rst/intro_dynamic_inventory.rst +++ b/docsite/latest/rst/intro_dynamic_inventory.rst @@ -1,4 +1,4 @@ -.. _patterns: +.. _dynamic_inventory: Dynamic Inventory ================= diff --git a/docsite/latest/rst/intro_getting_started.rst b/docsite/latest/rst/intro_getting_started.rst index ba45993c6c8..38c5791735f 100644 --- a/docsite/latest/rst/intro_getting_started.rst +++ b/docsite/latest/rst/intro_getting_started.rst @@ -111,7 +111,7 @@ Also note that host key checking in paramiko mode is reasonably slow, therefore .. seealso:: - :doc:`intro_ad_hoc` + :doc:`intro_adhoc` Examples of basic commands :doc:`playbooks` Learning ansible's configuration management language diff --git a/docsite/latest/rst/intro_installation.rst b/docsite/latest/rst/intro_installation.rst index 51bd59cee25..fee11006abb 100644 --- a/docsite/latest/rst/intro_installation.rst +++ b/docsite/latest/rst/intro_installation.rst @@ -110,7 +110,7 @@ Ansible also uses the the following Python modules that need to be installed:: $ sudo pip install paramiko PyYAML jinja2 Once running the env-setup script you'll be running from checkout and the default inventory file -will be /etc/ansible/hosts. You can optionally specify an inventory file (see :doc:`intro_inventroy`) +will be /etc/ansible/hosts. You can optionally specify an inventory file (see :doc:`intro_inventory`) other than /etc/ansible/hosts: .. code-block:: bash @@ -274,7 +274,7 @@ Now run a live command on all of your nodes: $ ansible all -a "/bin/echo hello" Congratulations. You've just contacted your nodes with Ansible. It's -soon going to be time to read some of the more real-world :doc:`examples`, and explore +soon going to be time to read some of the more real-world :doc:`intro_adhoc`, and explore what you can do with different modules, as well as the Ansible :doc:`playbooks` language. Ansible is not just about running commands, it also has powerful configuration management and deployment features. There's more to @@ -325,7 +325,7 @@ feature. .. seealso:: - :doc:`examples` + :doc:`intro_adhoc` Examples of basic commands :doc:`playbooks` Learning ansible's configuration management language diff --git a/docsite/latest/rst/playbooks_best_practices.rst b/docsite/latest/rst/playbooks_best_practices.rst index e7616f74977..5b843bb6ed9 100644 --- a/docsite/latest/rst/playbooks_best_practices.rst +++ b/docsite/latest/rst/playbooks_best_practices.rst @@ -262,7 +262,7 @@ parameter in your playbooks to make it clear, especially as some modules support Group By Roles ++++++++++++++ -A system can be in multiple groups. See :doc:`patterns`. Having groups named after things like +A system can be in multiple groups. See :doc:`intro_inventory` and :doc:`intro_patterns`. Having groups named after things like *webservers* and *dbservers* is repeated in the examples because it's a very powerful concept. This allows playbooks to target machines based on role, as well as to assign role specific variables @@ -348,9 +348,9 @@ changed the rules that are automating your infrastructure. Review the basic playbook features :doc:`modules` Learn about available modules - :doc:`moduledev` + :doc:`developing_modules` Learn how to extend Ansible by writing your own modules - :doc:`patterns` + :doc:`intro_patterns` Learn about how to select hosts `Github examples directory `_ Complete playbook files from the github project source diff --git a/docsite/latest/rst/playbooks_conditionals.rst b/docsite/latest/rst/playbooks_conditionals.rst index 8d5f1cb795e..efcd268f1a3 100644 --- a/docsite/latest/rst/playbooks_conditionals.rst +++ b/docsite/latest/rst/playbooks_conditionals.rst @@ -85,7 +85,7 @@ If a required variable has not been set, you can skip or fail using Jinja2's This is especially useful in combination with the conditional import of vars files (see below). -Note that when combining `when` with `with_items` (see :doc:`playbook_loops`), be aware that the `when` statement is processed separately for each item. This is by design:: +Note that when combining `when` with `with_items` (see :doc:`playbooks_loops`), be aware that the `when` statement is processed separately for each item. This is by design:: tasks: - command: echo {{ item }} diff --git a/docsite/latest/rst/playbooks_roles.rst b/docsite/latest/rst/playbooks_roles.rst index 28b8dd4b093..30da9ecb959 100644 --- a/docsite/latest/rst/playbooks_roles.rst +++ b/docsite/latest/rst/playbooks_roles.rst @@ -63,7 +63,7 @@ contain all of my wordpress tasks in a single wordpress.yml file, and use it lik - include: wordpress.yml user=alice - include: wordpress.yml user=bob -Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`intro_variables`. +Variables passed in can then be used in the included files. We've already covered them a bit in :doc:`playbooks_variables`. You can reference them like this:: {{ user }} diff --git a/docsite/latest/rst/playbooks_variables.rst b/docsite/latest/rst/playbooks_variables.rst index 06bd8d13c77..1e1a4742d21 100644 --- a/docsite/latest/rst/playbooks_variables.rst +++ b/docsite/latest/rst/playbooks_variables.rst @@ -73,8 +73,7 @@ To see what information is available, try the following:: ansible hostname -m setup -The results of this can be used to create dynamic groups of hosts that match particular critera, see the :doc:`group_by` for details, -as well as in generalized conditional statements as discussed in the `playbook_conditionals` chapter. +The results of this can be used to create dynamic groups of hosts that match particular critera, see the :doc:`modules` documentation on 'group_by' for details, as well as in generalized conditional statements as discussed in the `playbook_conditionals` chapter. Turning Off Facts `````````````````