Skip to content

Commit 3e40cf5

Browse files
committed
moar refs
1 parent 25197d1 commit 3e40cf5

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

docs/docsite/rst/community/collection_contributors/collection_requirements.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,9 @@ To be included in the `ansible` package, collections must meet the following cri
532532
* `Collection requirements <https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_requirements.html>`_ (this document).
533533

534534
* 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.
536538
* To pass the Ansible :ref:`sanity tests <testing-sanity>`.
537539
* To have :ref:`unit <unit-tests>`_and / or :ref:`integration tests <integration-tests>` according to the corresponding sections of this document.
538540

docs/docsite/rst/community/documentation_contributions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,5 +235,5 @@ The Documentation Working Group (DaWGs) meets weekly on Tuesdays in the Docs cha
235235

236236
.. seealso::
237237
:ref:`More about testing module documentation <testing_module_documentation>`
238-
239238
:ref:`More about documenting modules <module_documenting>`
239+
:ref:`More about documenting plugins <plugins_documenting>`

docs/docsite/rst/community/maintainers_guidelines.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Maintaining good collection documentation
147147

148148
Maintainers look after the collection documentation to ensure it matches the :ref:`style_guide`. This includes keeping the following documents accurate and updated regularly:
149149

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>`.
151151
* Collection user guides that follow the :ref:`Collection documentation format <collections_doc_dir>`.
152152
* Repository files that includes at least a ``README`` and ``CONTRIBUTING`` file.
153153

0 commit comments

Comments
 (0)