From 6a2902c8d55f366bd577436effa2426b04ce65ee Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Tue, 22 Oct 2019 16:50:02 -0400 Subject: [PATCH] clarify no subfolders and md only for collections /docs folder (#63808) --- docs/docsite/rst/dev_guide/developing_collections.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docsite/rst/dev_guide/developing_collections.rst b/docs/docsite/rst/dev_guide/developing_collections.rst index 5466767afd1..e27df41fb3a 100644 --- a/docs/docsite/rst/dev_guide/developing_collections.rst +++ b/docs/docsite/rst/dev_guide/developing_collections.rst @@ -60,7 +60,7 @@ See :ref:`collections_galaxy_meta` for details. docs directory --------------- -Keep general documentation for the collection here. Plugins and modules still keep their specific documentation embedded as Python docstrings. Use the ``docs`` folder to describe how to use the roles and plugins the collection provides, role requirements, and so on. Currently we are looking at Markdown as the standard format for documentation files, but this is subject to change. +Put general documentation for the collection here. Keep the specific documentation for plugins and modules embedded as Python docstrings. Use the ``docs`` folder to describe how to use the roles and plugins the collection provides, role requirements, and so on. Use markdown and do not add subfolders. Use ``ansible-doc`` to view documentation for plugins inside a collection: