Various updates for Ansible code best practices

.github/workflows/extra-docs-linting.yml

@@ -0,0 +1,35 @@
+---
+name: Lint extra docsite docs and links
+on:
+  # Run CI against all pushes (direct commits, also merged PRs), Pull Requests
+  push:
+    branches:
+      - main
+      - stable-*
+  pull_request:
+  # Run CI once per day (at 06:00 UTC)
+  # This ensures that even if there haven't been commits that we are still testing against latest version of ansible-test for each ansible-base version
+  schedule:
+    - cron: '0 6 * * *'
+
+jobs:
+  docsite:
+    name: Lint extra docsite docs and links
+    permissions:
+      contents: read
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out code
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: '3.10'
+
+      - name: Install antsibull-docs
+        run: pip install antsibull-docs --disable-pip-version-check
+
+      - name: Run collection docs linter
+        run: antsibull-docs lint-collection-docs . --plugin-docs --skip-rstcheck

.gitignore

@@ -1,3 +1,6 @@
+/tests/output/
+/changelogs/.plugin-cache.yaml
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -145,4 +148,4 @@ Vagrantfile
 .vagrant
 
 # JSON File for Batch Playbook
-batch_populator.json
+batch_populator.json

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Community Code of Conduct
+
+Please see the official [Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+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/kentik_ansible_collection).
+
+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)

changelogs/changelog.yaml

@@ -0,0 +1 @@
+releases: {}

changelogs/config.yaml

@@ -0,0 +1,32 @@
+---
+add_plugin_period: true
+changelog_filename_template: ../CHANGELOG.rst
+changelog_filename_version_depth: 0
+changes_file: changelog.yaml
+changes_format: combined
+keep_fragments: false
+mention_ancestor: true
+new_plugins_after_name: removed_features
+notesdir: fragments
+prelude_section_name: release_summary
+prelude_section_title: Release Summary
+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: Kentik Ansible Collection
+trivial_section_name: trivial
+use_fqcn: true

changelogs/fragments/.keep

@@ -0,0 +1 @@
+

codecov.yml

@@ -0,0 +1,2 @@
+---
+comment: false

docs/docsite/links.yml

@@ -0,0 +1,44 @@
+---
+# This will make sure that plugin and module documentation gets Edit on GitHub links
+# that allow users to directly create a PR for this plugin or module in GitHub's UI.
+# Remove this section if the collection repository is not on GitHub, or if you do not want this
+# functionality for your collection.
+edit_on_github:
+  repository: kentik/kentik_ansible_collection
+  branch: main
+  # If your collection root (the directory containing galaxy.yml) does not coincide with your
+  # repository's root, you have to specify the path to the collection root here. For example,
+  # if the collection root is in a subdirectory ansible_collections/community/REPO_NAME
+  # in your repository, you have to set path_prefix to 'ansible_collections/community/REPO_NAME'.
+  path_prefix: ""
+
+# Here you can add arbitrary extra links. Please keep the number of links down to a
+# minimum! Also please keep the description short, since this will be the text put on
+# a button.
+#
+# Also note that some links are automatically added from information in galaxy.yml.
+# The following are automatically added:
+#   1. A link to the issue tracker (if `issues` is specified);
+#   2. A link to the homepage (if `homepage` is specified and does not equal the
+#      `documentation` or `repository` link);
+#   3. A link to the collection's repository (if `repository` is specified).
+
+extra_links:
+  - description: Report an issue
+    url: https://github.com/kentik/kentik_ansible_collection/issues/new/choose
+# Specify communication channels for your collection. We suggest to not specify more
+# than one place for communication per communication tool to avoid confusion.
+# communication:
+#   matrix_rooms:
+#     - topic: General usage and support questions
+#       room: '#users:ansible.im'
+#   irc_channels:
+#     - topic: General usage and support questions
+#       network: Libera
+#       channel: '#ansible'
+#   mailing_lists:
+#     - topic: Ansible Project List
+#       url: https://groups.google.com/g/ansible-project
+# You can also add a `subscribe` field with an URI that allows to subscribe
+# to the mailing list. For lists on https://groups.google.com/ a subscribe link is
+# automatically generated.

playbooks/nautobot_inventory.yml

@@ -1,6 +1,6 @@
 plugin: networktocode.nautobot.inventory
-api_endpoint: https://10.1.1.12
+api_endpoint: https://192.0.2.12
 validate_certs: False
 config_context: False
 device_query_filters:
-  - has_primary_ip: 'true'
+  - has_primary_ip: 'true'

plugins/modules/__init__.py

@@ -0,0 +1 @@
+