diff --git a/docs/docsite/rst/dev_guide/style_guide/index.rst b/docs/docsite/rst/dev_guide/style_guide/index.rst index 975fd17a126..a50a3180e90 100644 --- a/docs/docsite/rst/dev_guide/style_guide/index.rst +++ b/docs/docsite/rst/dev_guide/style_guide/index.rst @@ -171,13 +171,33 @@ The second example adds custom text for the link. Adding links to modules and plugins ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -* Module links use the module name followed by ``_module`` for the anchor. -* Plugin links use the plugin name followed by the plugin type. For example, :ref:`enable become plugin `). +Ansible 2.10 and later require the extended Fully Qualified Collection Name (FQCN) as part of the links: + +.. code-block:: text + + ansible_collections. + FQCN + _module + +For example: + + .. code-block:: rst + + :ref:`ansible.builtin.first_found lookup plugin ` + +displays as :ref:`ansible.builtin.first_found lookup plugin `. + +Modules require different suffixes from other plugins: + +* Module links use this extended FQCN module name with ``_module`` for the anchor. +* Plugin links use this extended FQCN plugin name with the plugin type (``_connection`` for example). .. code-block:: rst - :ref:`this module `` - :ref:`that connection plugin ` + :ref:`arista.eos.eos_config ` + :ref:`community.kubernetes.kubectl connection plugin ` + +.. note:: + + ``ansible.builtin`` is the FQCN for modules included in ``ansible.base``. Documentation links are the only place you prepend ``ansible_collections`` to the FQCN. This is used by the documentation build scripts to correctly fetch documentation from collections on Ansible Galaxy. .. _local_toc: