summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranarcat <anarcat@users.noreply.github.com>2017-08-30 10:57:10 -0400
committerJohn R Barker <john@johnrbarker.com>2017-08-30 15:57:10 +0100
commit8bb12fba3dd16b8b148f2632d5f6aa3b72137dca (patch)
treed799a4bef2d02a2beb3dc5cd176e831ecec6a685
parent4b7e4cfa2bfaf9042b94a82ecf156bd1310f4268 (diff)
downloadansible-8bb12fba3dd16b8b148f2632d5f6aa3b72137dca.tar.gz
fix two broken absolute links (#28766)
* fix two broken absolute links instead of using absolute links, we use normal Sphinx mechanics to make sure those links work portably in the future * reformat list so paragraphs are properly indented
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules.rst22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules.rst b/docs/docsite/rst/dev_guide/developing_modules.rst
index 142f9d81b1..b076ce949d 100644
--- a/docs/docsite/rst/dev_guide/developing_modules.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules.rst
@@ -20,7 +20,7 @@ See :doc:`../modules` for a list of existing modules.
Modules can be written in any language and are found in the path specified
by :envvar:`ANSIBLE_LIBRARY` or the ``--module-path`` command line option or
-in the `library section of the Ansible configuration file <http://docs.ansible.com/ansible/intro_configuration.html#library>`_.
+in the :ref:`library section of the Ansible configuration file <library>`.
.. _module_dev_should_you:
@@ -31,28 +31,28 @@ develop a module. Ask the following questions:
1. Does a similar module already exist?
-There are a lot of existing modules available. You should check out the list of existing modules at :doc:`../modules`
+ There are a lot of existing modules available. You should check out the list of existing modules at :doc:`../modules`
2. Has someone already worked on a similar pull request?
-It's possible that someone has already started developing a similar PR. There are a few ways to find open module pull requests:
+ It's possible that someone has already started developing a similar PR. There are a few ways to find open module pull requests:
-* `GitHub new module PRs <https://github.com/ansible/ansible/labels/new_module>`_
-* `All updates to modules <https://github.com/ansible/ansible/labels/module>`_
-* `New module PRs listed by directory <https://ansible.sivel.net/pr/byfile.html>`_ search for `lib/ansible/modules/`
+ * `GitHub new module PRs <https://github.com/ansible/ansible/labels/new_module>`_
+ * `All updates to modules <https://github.com/ansible/ansible/labels/module>`_
+ * `New module PRs listed by directory <https://ansible.sivel.net/pr/byfile.html>`_ search for `lib/ansible/modules/`
-If you find an existing PR that looks like it addresses the issue you are trying to solve, please provide feedback on the PR - this will speed up getting the PR merged.
+ If you find an existing PR that looks like it addresses the issue you are trying to solve, please provide feedback on the PR - this will speed up getting the PR merged.
3. Should you use or develop an action plugin instead?
-Action plugins get run on the master instead of on the target. For modules like file/copy/template, some of the work needs to be done on the master before the module executes on the target. Action plugins execute first on the master and can then execute the normal module on the target if necessary.
+ Action plugins get run on the master instead of on the target. For modules like file/copy/template, some of the work needs to be done on the master before the module executes on the target. Action plugins execute first on the master and can then execute the normal module on the target if necessary.
-For more information about action plugins, `read the action plugins documentation here <https://docs.ansible.com/ansible/dev_guide/developing_plugins.html>`_.
+ For more information about action plugins, :doc:`read the action
+ plugins documentation here <developing_plugins>`.
4. Should you use a role instead?
-Check out the roles documentation `available here <http://docs.ansible.com/ansible/playbooks_reuse_roles.html#roles>`_.
-
+ Check out the :ref:`roles` documentation for details.
.. _developing_modules_all: