From af7c9deb4ed4c6b9a526a40f976bb52c570fced1 Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Tue, 15 Feb 2022 05:40:50 -0500 Subject: [PATCH] add crosslinks for changelog fragments (#77022) --- docs/docsite/rst/community/collection_development_process.rst | 4 ++-- docs/docsite/rst/community/development_process.rst | 4 ++-- .../rst/dev_guide/developing_collections_changelogs.rst | 2 ++ docs/docsite/rst/dev_guide/testing/sanity/changelog.rst | 2 ++ 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/docsite/rst/community/collection_development_process.rst b/docs/docsite/rst/community/collection_development_process.rst index 86d49dbec48..865d71b225a 100644 --- a/docs/docsite/rst/community/collection_development_process.rst +++ b/docs/docsite/rst/community/collection_development_process.rst @@ -43,8 +43,8 @@ We do not merge every PR. Here are some tips for making your PR useful, attracti .. _collection_changelogs: -Changelogs ----------- +Creating changelog fragments +----------------------------- Changelogs help users and developers keep up with changes to Ansible collections. Many collections build changelogs for each release from fragments. For collections that use this model, you **must** add a changelog fragment to any PR that changes functionality or fixes a bug. diff --git a/docs/docsite/rst/community/development_process.rst b/docs/docsite/rst/community/development_process.rst index e395687d936..812b966a025 100644 --- a/docs/docsite/rst/community/development_process.rst +++ b/docs/docsite/rst/community/development_process.rst @@ -140,8 +140,8 @@ We do not merge every PR. Here are some tips for making your PR useful, attracti .. _community_changelogs: -Changelogs ----------- +Creating changelog fragments +------------------------------ Changelogs help users and developers keep up with changes to ansible-core and Ansible collections. Ansible and many collections build changelogs for each release from fragments. For ansible-core and collections using this model, you **must** add a changelog fragment to any PR that changes functionality or fixes a bug. diff --git a/docs/docsite/rst/dev_guide/developing_collections_changelogs.rst b/docs/docsite/rst/dev_guide/developing_collections_changelogs.rst index 36f74d16f6e..3e164090d2b 100644 --- a/docs/docsite/rst/dev_guide/developing_collections_changelogs.rst +++ b/docs/docsite/rst/dev_guide/developing_collections_changelogs.rst @@ -70,6 +70,8 @@ If your collection is part of Ansible, use one of the following three options t .. seealso:: + :ref:`collection_changelogs` + Learn how to create good changelog fragments. :ref:`collections` Learn how to install and use collections. :ref:`contributing_maintained_collections` diff --git a/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst b/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst index 8cb53329dc5..2d557c72d5f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst @@ -15,3 +15,5 @@ One or more of the following sections are required: - known_issues New modules and plugins must not be included in changelog fragments. + +See :ref:`collection_changelogs` for details.