diff options
| author | Sandra McCann <samccann@redhat.com> | 2022-03-30 16:46:09 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-30 13:46:09 -0700 |
| commit | 8caa6efaab6ed50193b6595825902804b7a05d6c (patch) | |
| tree | c55f3201168b0a2f8f0161338e559a36e6a19a02 /docs/docsite/rst/dev_guide/developing_collections_structure.rst | |
| parent | 4b51e61645da35861b872a8d1033965792255092 (diff) | |
| download | ansible-8caa6efaab6ed50193b6595825902804b7a05d6c.tar.gz | |
add links.yml to collection structure docs (#77415)
* add links.yml to collection structure docs
* fix link
* Update docs/docsite/rst/dev_guide/developing_collections_structure.rst
Diffstat (limited to 'docs/docsite/rst/dev_guide/developing_collections_structure.rst')
| -rw-r--r-- | docs/docsite/rst/dev_guide/developing_collections_structure.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_collections_structure.rst b/docs/docsite/rst/dev_guide/developing_collections_structure.rst index de6629b34c..0c3f7392f1 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_structure.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_structure.rst @@ -70,7 +70,9 @@ For community collections included in the Ansible PyPI package, docs.ansible.com toctree: - scenario_guide -The index page of the documentation for your collection displays the title you define in ``docs/docsite/extra-docs.yml`` with a link to your extra documentation. For an example, see the `community.docker collection repo <https://github.com/ansible-collections/community.docker/tree/main/docs/docsite>`_ and the `community.docker collection documentation <https://docs.ansible.com/ansible/latest/collections/community/docker/index.html>`_. +The index page of the documentation for your collection displays the title you define in ``docs/docsite/extra-docs.yml`` with a link to your extra documentation. For an example, see the `community.docker collection repo <https://github.com/ansible-collections/community.docker/tree/main/docs/docsite>`_ and the `community.docker collection documentation <https://docs.ansible.com/ansible/latest/collections/community/docker/index.html>`_. + +You can add extra links to your collection index page and plugin pages with the ``docs/docsite/links.yml`` file. This populates the links under `Description and Communications <https://docs.ansible.com/ansible/devel/collections/community/dns/index.html#plugins-in-community-dns>`_ headings as well as links at the end of the individual plugin pages. See the `collection_template links.yml file <https://github.com/ansible-collections/collection_template/blob/main/docs/docsite/links.yml>`_ for a complete description of the structure and use of this file to create links. Plugin and module documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |