Internal refs (#39094)

* fixes community refs

* fixes appendix refs

* fixes scenario refs, keeps ACI guide link to devel

* fixes windows refs

* fixes user guide refs

* fixes dev guide refs
This commit is contained in:
Alicia Cozine
2018-04-20 14:17:02 -05:00
committed by scottb
parent c4e298b808
commit bbfd6c6ab1
22 changed files with 38 additions and 39 deletions

View File

@@ -22,7 +22,7 @@ See :ref:`all_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 :envvar:`library section of the Ansible configuration file <ANSIBLE_LIBRARY>`.
.. _module_dev_should_you:
@@ -49,11 +49,11 @@ If you find an existing PR that looks like it addresses the issue you are trying
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, read the :ref:`action plugins documentation <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<playbooks_reuse_roles>`.
5. Should you write multiple modules instead of one module?

View File

@@ -33,7 +33,7 @@ The following checklist items are important guidelines for people who want to c
'supported_by': 'community',
'metadata_version': '1.1'}
The complete module metadata specification is here: `Ansible metadata block <https://docs.ansible.com/ansible/dev_guide/developing_modules_documenting.html#ansible-metadata-block>`_
Read the complete :ref:`module metadata specification <ansible-metadata-block>` for more information.
* Documentation: Make sure it exists
* Module documentation should briefly and accurately define what each module and option does, and how it works with others in the underlying system. Documentation should be written for broad audience--readable both by experts and non-experts. This documentation is not meant to teach a total novice, but it also should not be reserved for the Illuminati (hard balance).

View File

@@ -67,6 +67,7 @@ add the newer line above the older one, like so:
# Copyright: (c) 2015, [Original Contributor(s)]
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
.. _ansible_metadata_block:
ANSIBLE_METADATA Block
----------------------
@@ -129,7 +130,7 @@ Fields
certified instead)
For information on what the support level values entail, please see
`Modules Support <http://docs.ansible.com/ansible/modules_support.html>`_.
:ref:`Modules Support <modules_support>`.
:status: This field records information about the module that is
important to the end user. It's a list of strings. The default value

View File

@@ -129,7 +129,7 @@ If there are multiple people that can be notified, please list them. That avoids
**Review Module web docs**
Review the autogenerated module documentation for each of your modules, found in `Module Docs <http://docs.ansible.com/ansible/modules_by_category.html>`_ to ensure they are correctly formatted. If there are any issues please fix by raising a single PR.
Review the autogenerated module documentation for each of your modules, found in :ref:`Module Docs <modules_by_category>` to ensure they are correctly formatted. If there are any issues please fix by raising a single PR.
If the module documentation hasn't been published live yet, please let a member of the Ansible Core Team know in the ``#ansible-devel`` IRC channel.

View File

@@ -279,7 +279,7 @@ The following is an example of how this lookup is called::
For more example lookup plugins, check out the source code for the lookup plugins that are included with Ansible here: `lib/ansible/plugins/lookup <https://github.com/ansible/ansible/tree/devel/lib/ansible/plugins/lookup>`_.
For more usage examples of lookup plugins, see `Using Lookups <http://docs.ansible.com/ansible/playbooks_lookups.html>`_.
For more usage examples of lookup plugins, see :ref:`Using Lookups<playbooks_lookups>`.
.. _developing_vars_plugins:

View File

@@ -1,16 +1,10 @@
Resources
````````````````
Internal resources
-------------------------
- https://docs.ansible.com/
- https://sites.google.com/a/ansibleworks.com/ansible-intranet/
- ??? intranet Engineering doc???
* Follow the style of the :ref:`Ansible Documentation<ansible_documentation>`
* Ask for advice on IRC, on the ``#ansible-devel`` Freenode channel
* Review these online style guides:
* `AP Stylebook <https://www.apstylebook.com>`_
* `Chicago Manual of Style <http://www.chicagomanualofstyle.org/home.html>`_
* `Strunk and White's Elements of Style <https://www.crockford.com/wrrrld/style.html>`_
External Resources
-------------------------
- https://www.apstylebook.com
- http://www.chicagomanualofstyle.org/home.html
- https://www.crockford.com/wrrrld/style.html
- http://orwell.ru
- http://www.computeruser.com