Add more documentation in readme

CHANGELOG.md

@@ -0,0 +1,8 @@
+# Kentik Ansible EDA Source Plugin Release Notes
+
+**Topics**
+- <a href="#v1-0-6">v1\.0\.6</a>
+
+<a id="v1-0-6"></a>
+## v1\.0\.6
+

CHANGELOG.rst

@@ -1,5 +1,9 @@
-Will be updated by antsibull-changelog. Do not edit this manually!
+==============================================
+Kentik Ansible EDA Source Plugin Release Notes
+==============================================
 
-See https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.rst for information on how to use antsibull-changelog.
+.. contents:: Topics
+
+v1.0.6
+======
 
-Check out ``changelogs/config.yaml`` for its configuration. You need to change at least the ``title`` field in there.

CONTRIBUTING.md

@@ -1,3 +1,15 @@
 # Contributing
 
-Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html).
+The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.
+
+We are actively accepting new contributors and all types of contributions are very welcome.
+
+Don't know how to start? Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html)!
+
+If you find problems, please open an issue or create a PR against the [Kentik collection repository](https://github.com/kentik/ansible_eda).
+
+We also use the following guidelines:
+
+* [Collection review checklist](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html)
+* [Ansible development guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
+* [Ansible collection development guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)

README.md

@@ -1,9 +1,52 @@
-# Kentik Alert Notification Plugin for Ansible Event Driven Ansible
+# Kentik Collection for Ansible
 
-This event source plugin from Kentik accepts alert notification JSON and works in conjunction with Ansible EDA rulebooks to allow users to automate changes to their environment.
+The Kentik Collection for Ansible includes an event source plugin from Kentik accepts alert notification JSON and works in conjunction with Ansible EDA rulebooks to allow users to automate changes to their environment.
 
-## Requirements
-* Kentik portal account
+## Code of Conduct
+We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html) in all our interactions within this project.
+
+If you encounter abusive behavior, please refer to the [policy violations](https://docs.ansible.com/ansible/devel/community/code_of_conduct.html#policy-violations) section of the Code for information on how to raise a complaint.
+
+## Communication
+
+Join us on:
+* Email:
+    * [Support email](mailto:[email protected])
+* Slack:
+    * [Kentik Users](https://www.kentik.com/go/kentik-community-slack-signup/): Slack workspace for all Kentik users to colloborate
+
+For more information about communication with the Ansible community, refer to the [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).
+
+## Contributing to this collection
+
+<!--Describe how the community can contribute to your collection. At a minimum, fill up and include the CONTRIBUTING.md file containing how and where users can create issues to report problems or request features for this collection. List contribution requirements, including preferred workflows and necessary testing, so you can benefit from community PRs. If you are following general Ansible contributor guidelines, you can link to - [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html). List the current maintainers (contributors with write or higher access to the repository). The following can be included:-->
+
+The content of this collection is made by people like you, a community of individuals collaborating on making the world better through developing automation software.
+
+We are actively accepting new contributors and all types of contributions are very welcome.
+
+Don't know how to start? Refer to the [Ansible community guide](https://docs.ansible.com/ansible/devel/community/index.html)!
+
+If you find problems, please open an issue or create a PR against the [Kentik collection repository](https://github.com/kentik/ansible_eda).
+
+See [CONTRIBUTING.md](https://github.com/kentik/ansible_eda/blob/main/CONTRIBUTING.md) for more details.
+
+We also use the following guidelines:
+
+* [Collection review checklist](https://docs.ansible.com/ansible/devel/community/collection_contributors/collection_reviewing.html)
+* [Ansible development guide](https://docs.ansible.com/ansible/devel/dev_guide/index.html)
+* [Ansible collection development guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections)
+
+## Tested with Ansible
+
+<!-- List the versions of Ansible the collection has been tested with. Must match what is in galaxy.yml. -->
+Tested with Ansible Core >= 2.14.2 versions, and the current development version of Ansible. Ansible Core versions prior to 2.14.2 are not supported.
+
+## External requirements
+
+<!-- List any external resources the collection depends on, for example minimum versions of an OS, libraries, or utilities. Do not list other Ansible collections here. -->
+
+* [Kentik portal account](https://portal.kentik.com)
 * Ansible Automation Platform with EDA Controller instance
 
 ## Example rulebook
@@ -32,12 +75,47 @@ This event source plugin from Kentik accepts alert notification JSON and works i
           name: playbooks/example_playbook.yml
 ```
 
+### Installing the Collection from Ansible Galaxy
+
+Before using this collection, you need to install it with the Ansible Galaxy command-line tool:
+```bash
+ansible-galaxy collection install kentik.ansible_eda
+```
+
+You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:
+```yaml
+---
+collections:
+  - name: kentik.ansible_eda
+```
+
+Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the `ansible` package. To upgrade the collection to the latest available version, run the following command:
+```bash
+ansible-galaxy collection install kentik.ansible_eda --upgrade
+```
+
+You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version `0.1.0`:
+
+```bash
+ansible-galaxy collection install kentik.ansible_eda:==1.0.1
+```
+
+See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.
+
+## Release notes
+<!-- Updated using antsibull-changelog (https://github.com/ansible-community/antsibull-changelog/blob/main/docs/changelogs.md)-->
+
+See the [changelog](https://github.com/kentik/ansible_eda/blob/main/CHANGELOG.rst).
+
 ## Licensing
-We are using GPL 3.0 as our default.
+
+GNU General Public License v3.0 or later.
+
+See [LICENSE](https://github.com/kentik/ansible_eda/blob/main/LICENSE) to see the full text.
 
 ## Additional Questions/Remarks
 
-If you do have additional questions/remarks, feel free to reach out to Kentik support ([email protected]), via email.
+If you do have additional questions/remarks, feel free to reach out to [Kentik support](mailto:[email protected]), via email.
 
 If you think this template did not solve all your problems, please also let us know, either with a message or a pull request.
 Together we can improve this template to make it easier for our future projects.

changelogs/changelog.yaml

@@ -1 +1,4 @@
-releases: {}
+ancestor: null
+releases:
+  1.0.6:
+    release_date: '2024-03-08'

changelogs/config.yaml

@@ -2,20 +2,34 @@ changelog_filename_template: ../CHANGELOG.rst
 changelog_filename_version_depth: 0
 changes_file: changelog.yaml
 changes_format: combined
+ignore_other_fragment_extensions: true
 keep_fragments: false
 mention_ancestor: true
 new_plugins_after_name: removed_features
 notesdir: fragments
+output_formats:
+  - rst
+  - md
 prelude_section_name: release_summary
 prelude_section_title: Release Summary
+sanitize_changelog: true
 sections:
-  - ["major_changes", "Major Changes"]
-  - ["minor_changes", "Minor Changes"]
-  - ["breaking_changes", "Breaking Changes / Porting Guide"]
-  - ["deprecated_features", "Deprecated Features"]
-  - ["removed_features", "Removed Features (previously deprecated)"]
-  - ["security_fixes", "Security Fixes"]
-  - ["bugfixes", "Bugfixes"]
-  - ["known_issues", "Known Issues"]
-title: CHANGE THIS IN changelogs/config.yaml!
+  - - major_changes
+    - Major Changes
+  - - minor_changes
+    - Minor Changes
+  - - breaking_changes
+    - Breaking Changes / Porting Guide
+  - - deprecated_features
+    - Deprecated Features
+  - - removed_features
+    - Removed Features (previously deprecated)
+  - - security_fixes
+    - Security Fixes
+  - - bugfixes
+    - Bugfixes
+  - - known_issues
+    - Known Issues
+title: Kentik Ansible EDA Source Plugin
 trivial_section_name: trivial
+use_fqcn: true

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: kentik
 name: ansible_eda
-version: 1.0.5
+version: 1.0.6
 readme: README.md
 authors:
   - Kentik <[email protected]>

meta/runtime.yml

@@ -1,7 +1,7 @@
 ---
 # Collections must specify a minimum required ansible version to upload
 # to galaxy
-requires_ansible: ">=2.9.10"
+requires_ansible: ">=2.14.0"
 # Content that Ansible needs to load from another location or that has
 # been deprecated/removed
 # plugin_routing: