Add docs about contributing to docs (#46481)

* adds page on community contributions to docs
This commit is contained in:
Alicia Cozine 2018-10-24 10:14:01 -05:00 committed by Sandra McCann
parent e58e43279c
commit 4219d25fc7
7 changed files with 188 additions and 7 deletions

View file

@ -123,7 +123,7 @@ Module documentation should briefly and accurately define what each module and o
Each documentation field is described below. Before committing your module documentation, please test it at the command line and as HTML:
* As long as your module file is :ref:`available locally <local_modules>`, you can use ``ansible-doc -t module my_module_name`` to view your module documentation at the command line. Any parsing errors will be obvious - you can view details by adding ``-vvv`` to the command.
* You should also :ref:`test the HTML output <testing_documentation>` of your documentation.
* You should also :ref:`test the HTML output <testing_module_documentation>` of your module documentation.
Documentation fields
--------------------

View file

@ -246,7 +246,7 @@ Testing basics
====================
These two examples will get you started with testing your module code. Please review our :ref:`testing <developing_testing>` section for more detailed
information, including instructions for :ref:`testing documentation <testing_documentation>`, adding :ref:`integration tests <testing_integration>`, and more.
information, including instructions for :ref:`testing module documentation <testing_module_documentation>`, adding :ref:`integration tests <testing_integration>`, and more.
Sanity tests
------------

View file

@ -3,6 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. _style_guide:
*******************
Ansible Style Guide
*******************

View file

@ -1,12 +1,12 @@
:orphan:
.. _testing_documentation:
.. _testing_module_documentation:
*********************
Testing documentation
*********************
****************************
Testing module documentation
****************************
Before you submit a module for inclusion in the main Ansible repo, you must test your documentation for correct HTML rendering and to ensure that the argspec matches the documentation.
Before you submit a module for inclusion in the main Ansible repo, you must test your module documentation for correct HTML rendering and to ensure that the argspec matches the documentation in your Python file. The community pages offer more information on :ref:`testing reStructuredText documentation <testing_documentation_locally>`.
To check the HTML output of your module documentation: