Add rendered Changelog to the docs site (ansible-collections#1047)

Add rendered Changelog to the docs site

SUMMARY
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
README.md
docs/docsite/extra-docs.yml
docs/docsite/rst/CHANGELOG.rst
ADDITIONAL INFORMATION
Related to ansible-community/community-team#61
fixes: ansible-collections#1042

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Bikouo Aubin <None>

CHANGELOG.rst

@@ -55,7 +55,7 @@ Minor Changes
 - aws_s3 - Add ``validate_bucket_name`` option, to control bucket name validation (https://github.com/ansible-collections/amazon.aws/pull/615).
 - aws_s3 - The ``aws_s3`` module has been renamed to ``s3_object`` (https://github.com/ansible-collections/amazon.aws/pull/869).
 - aws_s3 - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/amazon.aws/pull/845).
-- ec2_eni - Change parameter ``device_index`` data type to string when passing to `describe_network_inter` api call (https://github.com/ansible-collections/amazon.aws/pull/877).
+- ec2_eni - Change parameter ``device_index`` data type to string when passing to ``describe_network_inter`` api call (https://github.com/ansible-collections/amazon.aws/pull/877).
 - ec2_eni - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/amazon.aws/pull/845).
 - ec2_group - add ``egress_rules`` as an alias for ``rules_egress`` (https://github.com/ansible-collections/amazon.aws/pull/878).
 - ec2_group - add ``purge_egress_rules`` as an alias for ``purge_rules_egress`` (https://github.com/ansible-collections/amazon.aws/pull/878).
@@ -264,7 +264,7 @@ Breaking Changes / Porting Guide
 Deprecated Features
 -------------------
 
-- module_utils - support for the original AWS SDK `boto` has been deprecated in favour of the `boto3`/`botocore` SDK. All `boto` based modules have either been deprecated or migrated to `botocore`, and the remaining support code in module_utils will be removed in release 4.0.0 of the amazon.aws collection. Any modules outside of the amazon.aws and community.aws collections based on the `boto` library will need to be migrated to the `boto3`/`botocore` libraries (https://github.com/ansible-collections/amazon.aws/pull/575).
+- module_utils - support for the original AWS SDK ``boto`` has been deprecated in favour of the ``boto3``/``botocore`` SDK. All ``boto`` based modules have either been deprecated or migrated to ``botocore``, and the remaining support code in module_utils will be removed in release 4.0.0 of the amazon.aws collection. Any modules outside of the amazon.aws and community.aws collections based on the ``boto`` library will need to be migrated to the ``boto3``/``botocore`` libraries (https://github.com/ansible-collections/amazon.aws/pull/575).
 
 v2.2.0
 ======
@@ -575,9 +575,9 @@ Major Changes
 Minor Changes
 -------------
 
-- Add `aws_security_token`, `aws_endpoint_url` and `endpoint_url` aliases to improve AWS module parameter naming consistency.
-- Add support for `aws_ca_bundle` to boto3 based AWS modules
-- Add support for configuring boto3 profiles using `AWS_PROFILE` and `AWS_DEFAULT_PROFILE`
+- Add ``aws_security_token``, ``aws_endpoint_url`` and ``endpoint_url`` aliases to improve AWS module parameter naming consistency.
+- Add support for ``aws_ca_bundle`` to boto3 based AWS modules
+- Add support for configuring boto3 profiles using ``AWS_PROFILE`` and ``AWS_DEFAULT_PROFILE``
 - Added check_mode support to aws_az_info
 - Added check_mode support to ec2_eni_info
 - Added check_mode support to ec2_snapshot_info
@@ -589,7 +589,7 @@ Minor Changes
 - ec2_asg - Add support for Max Instance Lifetime
 - ec2_asg - Add the ability to use mixed_instance_policy in launch template driven autoscaling groups
 - ec2_asg - Migrated to AnsibleAWSModule
-- ec2_placement_group - make `name` a required field.
+- ec2_placement_group - make ``name`` a required field.
 - ec2_vol_info - Code cleanup and use of the AWSRetry decorator to improve stability
 - ec2_vpc_net - Enable IPv6 CIDR assignment
 

README.md

@@ -113,7 +113,8 @@ You can also join us on:
 - [Getting Started With AWS Ansible Module Development and Community Contribution](https://www.ansible.com/blog/getting-started-with-aws-ansible-module-development)
 
 ## Release notes
-<!--Add a link to a changelog.rst file or an external docsite to cover this information. -->
+
+See the [rendered changelog](https://ansible-collections.github.io/amazon.aws/branch/main/collections/amazon/aws/docsite/CHANGELOG.html) or the [raw generated changelog](https://github.com/ansible-collections/amazon.aws/tree/main/CHANGELOG.rst).
 
 ## Roadmap
 

changelogs/changelog.yaml

@@ -56,10 +56,10 @@ releases:
         using ``catch_extra_error_codes``.  Some AWS modules may see an increase in
         transient failures due to AWS''s eventual consistency model.
       minor_changes:
-      - Add `aws_security_token`, `aws_endpoint_url` and `endpoint_url` aliases to
+      - Add ``aws_security_token``, ``aws_endpoint_url`` and ``endpoint_url`` aliases to
         improve AWS module parameter naming consistency.
-      - Add support for `aws_ca_bundle` to boto3 based AWS modules
-      - Add support for configuring boto3 profiles using `AWS_PROFILE` and `AWS_DEFAULT_PROFILE`
+      - Add support for ``aws_ca_bundle`` to boto3 based AWS modules
+      - Add support for configuring boto3 profiles using ``AWS_PROFILE`` and ``AWS_DEFAULT_PROFILE``
       - Added check_mode support to aws_az_info
       - Added check_mode support to ec2_eni_info
       - Added check_mode support to ec2_snapshot_info
@@ -77,7 +77,7 @@ releases:
       - ec2_asg - Add the ability to use mixed_instance_policy in launch template
         driven autoscaling groups
       - ec2_asg - Migrated to AnsibleAWSModule
-      - ec2_placement_group - make `name` a required field.
+      - ec2_placement_group - make ``name`` a required field.
       - ec2_vol_info - Code cleanup and use of the AWSRetry decorator to improve stability
       - ec2_vpc_net - Enable IPv6 CIDR assignment
     fragments:
@@ -656,12 +656,12 @@ releases:
       - ec2_vpc_subnet_facts - Remove deprecated ``ec2_vpc_subnet_facts`` alias.  Please
         use ``ec2_vpc_subnet_info`` instead.
       deprecated_features:
-      - module_utils - support for the original AWS SDK `boto` has been deprecated
-        in favour of the `boto3`/`botocore` SDK. All `boto` based modules have either
-        been deprecated or migrated to `botocore`, and the remaining support code
+      - module_utils - support for the original AWS SDK ``boto`` has been deprecated
+        in favour of the ``boto3``/``botocore`` SDK. All ``boto`` based modules have either
+        been deprecated or migrated to ``botocore``, and the remaining support code
         in module_utils will be removed in release 4.0.0 of the amazon.aws collection.
         Any modules outside of the amazon.aws and community.aws collections based
-        on the `boto` library will need to be migrated to the `boto3`/`botocore` libraries
+        on the ``boto`` library will need to be migrated to the ``boto3``/``botocore`` libraries
         (https://github.com/ansible-collections/amazon.aws/pull/575).
       major_changes:
       - amazon.aws collection - The amazon.aws collection has dropped support for
@@ -919,7 +919,7 @@ releases:
       - aws_s3 - ``resource_tags`` has been added as an alias for the ``tags`` parameter
         (https://github.com/ansible-collections/amazon.aws/pull/845).
       - ec2_eni - Change parameter ``device_index`` data type to string when passing
-        to `describe_network_inter` api call (https://github.com/ansible-collections/amazon.aws/pull/877).
+        to ``describe_network_inter`` api call (https://github.com/ansible-collections/amazon.aws/pull/877).
       - ec2_eni - ``resource_tags`` has been added as an alias for the ``tags`` parameter
         (https://github.com/ansible-collections/amazon.aws/pull/845).
       - ec2_group - add ``egress_rules`` as an alias for ``rules_egress`` (https://github.com/ansible-collections/amazon.aws/pull/878).

changelogs/fragments/1047-docsite-changelog.yml

@@ -0,0 +1,2 @@
+trivial:
+- docsite - added rendered copy of the changelog to docs site (https://github.com/ansible-collections/amazon.aws/pull/1047).

docs/docsite/extra-docs.yml

@@ -1,5 +1,8 @@
 ---
 sections:
+  - title: Changelog
+    toctree:
+      - CHANGELOG
   - title: Scenario Guide
     toctree:
       - guide_aws

docs/docsite/rst/CHANGELOG.rst

@@ -0,0 +1 @@
+../../../CHANGELOG.rst