mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 13:22:48 +00:00
Add docs about contributing to docs (#46481)
* adds page on community contributions to docs
This commit is contained in:
committed by
Sandra McCann
parent
e58e43279c
commit
4219d25fc7
@@ -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
|
||||
--------------------
|
||||
|
||||
Reference in New Issue
Block a user