diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst index 7b135580879..ecd8ebc22c5 100644 --- a/docs/docsite/rst/community/documentation_contributions.rst +++ b/docs/docsite/rst/community/documentation_contributions.rst @@ -6,7 +6,7 @@ Contributing to the Ansible Documentation Ansible has a lot of documentation and a small team of writers. Community support helps us keep up with new features, fixes, and changes. -Improving the documentation is an easy way to make your first contribution to the Ansible project. You do not have to be a programmer, since most of our documentation is written in YAML (module documentation) or `reStructuredText `_ (rST). Some collection-level documentation is written in a subset of `Markdown `_. If you are using Ansible, you already use YAML in your playbooks. rST and Markdown are mostly just text. You do not even need git experience, if you use the ``Edit on GitHub`` option. +Improving the documentation is an easy way to make your first contribution to the Ansible project. You do not have to be a programmer, since most of our documentation is written in YAML (module documentation) or `reStructuredText `_ (rST). Some collection-level documentation is written in a subset of `Markdown `_. If you are using Ansible, you already use YAML in your playbooks. rST and Markdown are mostly just text. You do not even need git experience, if you use the ``Edit on GitHub`` option. If you find a typo, a broken example, a missing topic, or any other error or omission on this documentation website, let us know. Here are some ways to support Ansible documentation: diff --git a/docs/docsite/rst/dev_guide/style_guide/index.rst b/docs/docsite/rst/dev_guide/style_guide/index.rst index 506b3059220..1cbe5b79906 100644 --- a/docs/docsite/rst/dev_guide/style_guide/index.rst +++ b/docs/docsite/rst/dev_guide/style_guide/index.rst @@ -136,7 +136,7 @@ We use: Syntax highlighting - Pygments ------------------------------ -The Ansible documentation supports a range of `Pygments lexers `_ +The Ansible documentation supports a range of `Pygments lexers `_ for `syntax highlighting `_ to make our code examples look good. Each code-block must be correctly indented and surrounded by blank lines. The Ansible documentation allows the following values: @@ -238,7 +238,7 @@ Modules require different suffixes from other plugins: Adding local TOCs ^^^^^^^^^^^^^^^^^ -The page you're reading includes a `local TOC `_. +The page you're reading includes a `local TOC `_. If you include a local TOC: * place it below, not above, the main heading and (optionally) introductory text diff --git a/docs/docsite/rst/user_guide/complex_data_manipulation.rst b/docs/docsite/rst/user_guide/complex_data_manipulation.rst index 6ea3021fee5..8466a3df2ce 100644 --- a/docs/docsite/rst/user_guide/complex_data_manipulation.rst +++ b/docs/docsite/rst/user_guide/complex_data_manipulation.rst @@ -239,5 +239,5 @@ https://www.reddit.com/r/ansible/comments/gj5a93/trying_to_get_uptime_from_secon Jinja2 filters included with Ansible :doc:`playbooks_tests` Jinja2 tests included with Ansible - `Jinja2 Docs `_ + `Jinja2 Docs `_ Jinja2 documentation, includes lists for core filters and tests diff --git a/docs/docsite/rst/user_guide/guide_rolling_upgrade.rst b/docs/docsite/rst/user_guide/guide_rolling_upgrade.rst index 6f2ca7423c8..abe7a72966c 100644 --- a/docs/docsite/rst/user_guide/guide_rolling_upgrade.rst +++ b/docs/docsite/rst/user_guide/guide_rolling_upgrade.rst @@ -198,7 +198,7 @@ Here's another example, from the same template: This loops over all of the hosts in the group called ``monitoring``, and adds an ACCEPT line for each monitoring hosts' default IPv4 address to the current machine's iptables configuration, so that Nagios can monitor those hosts. -You can learn a lot more about Jinja2 and its capabilities `here `_, and you +You can learn a lot more about Jinja2 and its capabilities `here `_, and you can read more about Ansible variables in general in the :ref:`playbooks_variables` section. .. _lamp_rolling_upgrade: diff --git a/docs/docsite/rst/user_guide/playbooks_variables.rst b/docs/docsite/rst/user_guide/playbooks_variables.rst index 73673476e96..75acc56ccc4 100644 --- a/docs/docsite/rst/user_guide/playbooks_variables.rst +++ b/docs/docsite/rst/user_guide/playbooks_variables.rst @@ -188,7 +188,7 @@ To reference an IP address from your facts using the dot notation:: Transforming variables with Jinja2 filters ========================================== -Jinja2 filters let you transform the value of a variable within a template expression. For example, the ``capitalize`` filter capitalizes any value passed to it; the ``to_yaml`` and ``to_json`` filters change the format of your variable values. Jinja2 includes many `built-in filters `_ and Ansible supplies many more filters. To find more examples of filters, see :ref:`playbooks_filters`. +Jinja2 filters let you transform the value of a variable within a template expression. For example, the ``capitalize`` filter capitalizes any value passed to it; the ``to_yaml`` and ``to_json`` filters change the format of your variable values. Jinja2 includes many `built-in filters `_ and Ansible supplies many more filters. To find more examples of filters, see :ref:`playbooks_filters`. .. _setting_variables: