Skip to content

Commit

Permalink
Cloud dev docs to rst (#56485)
Browse files Browse the repository at this point in the history
* Moves developer docs for AWS, ovirt, and openstack modules out of lib/ansible/, integrates them with dev_guide, with abadger's fix to make python snippets pass rstcheck
  • Loading branch information
acozine committed May 16, 2019
1 parent 75046f8 commit 118cf3e
Show file tree
Hide file tree
Showing 7 changed files with 771 additions and 732 deletions.
2 changes: 2 additions & 0 deletions docs/docsite/rst/dev_guide/developing_modules_documenting.rst
Expand Up @@ -278,6 +278,8 @@ You can link from your module documentation to other module docs, other resource
- To refer a collection of modules, use ``C(..)``, e.g. ``Refer to the C(win_*) modules.``
- Because it stands out better, using ``seealso`` is preferred for general references over the use of notes or adding links to the description.

.. _module_docs_fragments:

Documentation fragments
-----------------------

Expand Down
12 changes: 9 additions & 3 deletions docs/docsite/rst/dev_guide/index.rst
Expand Up @@ -22,9 +22,12 @@ Find the task that best describes what you want to do:
* What do I need to know before I start coding?
* I want to :ref:`set up my Python development environment <environment_setup>`.
* 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 a specific kind of module:
* a :ref:`network module <developing_modules_network>`
* a :ref:`Windows module <developing_modules_general_windows>`.
* an :ref:`Amazon module <AWS_module_development>`.
* an :ref:`OpenStack module <OpenStack_module_development>`.
* an :ref:`oVirt/RHV module <oVirt_module_development>`.
* 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:
Expand Down Expand Up @@ -62,6 +65,9 @@ If you prefer to read the entire guide, here's a list of the pages in order.
developing_modules_documenting
developing_modules_general_windows
developing_modules_general_aci
platforms/aws_guidelines
platforms/openstack_guidelines
platforms/ovirt_dev_guide
developing_modules_in_groups
testing
module_lifecycle
Expand Down

0 comments on commit 118cf3e

Please sign in to comment.