wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update links to AWS module guidelines to target the devel docsite since (#57465)

Browse source 
the GUIDELINES.md has been removed from devel on github.
This commit is contained in:
Ed Costello 2019-06-08 02:59:58 +12:00 committed by Alicia Cozine
parent bf9f21cc95
commit 819507840f
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/docsite/rst/dev_guide/developing_modules_best_practices.rst
View file

@ -160,7 +160,7 @@ Ansible conventions offer a predictable user interface across all modules, playb
* Implement declarative operations (not CRUD) so the user can ignore existing state and focus on final state. For example, use ``started/stopped``, ``present/absent``.
* Strive for a consistent final state (aka idempotency). If running your module twice in a row against the same system would result in two different states, see if you can redesign or rewrite to achieve consistent final state. If you can't, document the behavior and the reasons for it.
* Provide consistent return values within the standard Ansible return structure, even if NA/None are used for keys normally returned under other options.
* Follow additional guidelines that apply to families of modules if applicable. For example, AWS modules should follow `the Amazon guidelines <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md>`_
* Follow additional guidelines that apply to families of modules if applicable. For example, AWS modules should follow `the Amazon guidelines <https://docs.ansible.com/ansible/devel/dev_guide/platforms/aws_guidelines.html>`_
Module Security
===============

2
docs/docsite/rst/dev_guide/developing_modules_checklist.rst
View file

@ -40,5 +40,5 @@ Other checklists
================
* :ref:`Tips for module development <developing_modules_best_practices>`.
* `Amazon development checklist <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md>`_.
* `Amazon development checklist <https://docs.ansible.com/ansible/devel/dev_guide/platforms/aws_guidelines.html>`_.
* :ref:`Windows development checklist <developing_modules_general_windows>`.

2
docs/docsite/rst/dev_guide/index.rst
View file

@ -24,7 +24,7 @@ Find the task that best describes what you want to do:
* I want to :ref:`get started writing a module <developing_modules_general>`.
* I want to :ref:`write a network module <developing_modules_network>`.
* I want to :ref:`write a Windows module <developing_modules_general_windows>`.
* I want to `write an Amazon module <https://github.com/ansible/ansible/blob/devel/lib/ansible/modules/cloud/amazon/GUIDELINES.md>`_.
* I want to `write an Amazon module <https://docs.ansible.com/ansible/devel/dev_guide/platforms/aws_guidelines.html>`_.
* I want to :ref:`write a series of related modules <developing_modules_in_groups>` that integrate Ansible with a new product (for example, a database, cloud provider, network platform, etc.).
* I want to refine my code: