You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* The `Collection Inclusion Criteria Checklist <https://github.com/ansible-collections/overview/blob/main/collection_checklist.md>`_ covers most of the criteria from this document.
535
-
* :ref:`Ansible documentation format <module_documenting>` and the :ref:`style guide <style-guide>`.
535
+
* :ref:`Ansible module documentation format <module_documenting>`.
536
+
* :ref:`Ansible plugin documentation format <plugins_documenting>`.
537
+
* And the :ref:`style guide <style-guide>` for both.
536
538
* To pass the Ansible :ref:`sanity tests <testing-sanity>`.
537
539
* To have :ref:`unit <unit-tests>`_and / or :ref:`integration tests <integration-tests>` according to the corresponding sections of this document.
Copy file name to clipboardExpand all lines: docs/docsite/rst/community/maintainers_guidelines.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,7 +147,7 @@ Maintaining good collection documentation
147
147
148
148
Maintainers look after the collection documentation to ensure it matches the :ref:`style_guide`. This includes keeping the following documents accurate and updated regularly:
149
149
150
-
* Collection module and plugin documentation that adheres to the :ref:`Ansible documentation format <module_documenting>`.
150
+
* Collection module and plugin documentation that adheres to the :ref:`Ansible module documentation format <module_documenting>` and :ref:`Ansible plugin documentation format <plugins_documenting>`.
151
151
* Collection user guides that follow the :ref:`Collection documentation format <collections_doc_dir>`.
152
152
* Repository files that includes at least a ``README`` and ``CONTRIBUTING`` file.
0 commit comments