From d7f6493084acfc88225fd2102e81f392edb7c1ef Mon Sep 17 00:00:00 2001 From: Alicia Cozine <879121+acozine@users.noreply.github.com> Date: Wed, 17 Apr 2019 13:30:34 -0500 Subject: [PATCH] adds better links to tips and pitfalls page (#55458) --- docs/docsite/rst/dev_guide/developing_modules_checklist.rst | 5 ++++- docs/docsite/rst/dev_guide/index.rst | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst index 6b1b9e0a31..280879ae1b 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_checklist.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_checklist.rst @@ -5,7 +5,9 @@ Contributing your module to Ansible *********************************** -If you want to contribute a module to Ansible, you must meet our objective and subjective requirements. Modules accepted into the `main project repo `_ ship with every Ansible installation. However, contributing to the main project isn't the only way to distribute a module - you can embed modules in roles on Galaxy or simply share copies of your module code for :ref:`local use `. +If you want to contribute a module to Ansible, you must meet our objective and subjective requirements. Please read the details below, and also review our :ref:`tips for module development `. + +Modules accepted into the `main project repo `_ ship with every Ansible installation. However, contributing to the main project isn't the only way to distribute a module - you can embed modules in roles on Galaxy or simply share copies of your module code for :ref:`local use `. Contributing to Ansible: objective requirements =============================================== @@ -37,5 +39,6 @@ If your module meets our objective requirements, we'll review your code to see i Other checklists ================ +* :ref:`Tips for module development `. * `Amazon development checklist `_. * :ref:`Windows development checklist `. diff --git a/docs/docsite/rst/dev_guide/index.rst b/docs/docsite/rst/dev_guide/index.rst index d7c65ce3d0..135d69455d 100644 --- a/docs/docsite/rst/dev_guide/index.rst +++ b/docs/docsite/rst/dev_guide/index.rst @@ -31,6 +31,7 @@ Find the task that best describes what you want to do: * I want to :ref:`debug my module code `. * I want to :ref:`add tests `. * I want to :ref:`document my module `. + * I want to follow :ref:`conventions and tips for clean, usable module code `. * I want to :ref:`make sure my code runs on Python 2 and Python 3 `. * I want to work on other development projects: