README consistency and cleanup

CHANGELOG.rst

@@ -4,6 +4,15 @@ Opmisll.Infrahub Release Notes
 
 .. contents:: Topics
 
+v1.0.7
+======
+
+v1.0.6
+======
+
+v1.0.5
+======
+
 v1.0.4
 ======
 

README.md

@@ -2,10 +2,17 @@
 
 # Infrahub modules for Ansible using Ansible Collections
 
+[Infrahub](https://github.com/opsmill/infrahub) by [OpsMill](https://opsmill.com) acts as a central hub to manage the data, templates and playbooks that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars:
+
+- **A Flexible Schema**: A model of the infrastructure and the relation between the objects in the model, that's easily extensible.
+- **Version Control**: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database.
+- **Unified Storage**: By combining a graph database and git, Infrahub stores data and code needed to manage the infrastructure.
+
+## Support
+
 To keep the code simple, we only officially support the two latest releases of Infrahub and don't guarantee backwards compatibility beyond that. We do try and keep these breaking changes to a minimum, but sometimes changes to Infrahub's API cause us to have to make breaking changes.
 
 ## Requirements
-Requirements
 
 - The two latest Infrahub releases
 - Python >=3.9, <3.13
@@ -14,9 +21,9 @@ Requirements
 - Ansible 2.12+
 - Infrahub write-enabled token when using modules or read-only token for `lookup/inventory`
 
-## Docs
-Module documentation exists on [here](https://infrahub-ansible.readthedocs.io/en/latest/).
+## Documentation
 
+Please refer to the [opsmill.infrahub Ansible Collection](https://infrahub-ansible.readthedocs.io/en/latest/) documentation.
 
 ## Releasing, Versioning, and Deprecation
 
@@ -28,4 +35,4 @@ Releasing the current major version happens from the `develop` branch with a rel
 
 If backward incompatible changes are possible, we plan to deprecate the old behavior as early as possible. We also plan to backport at least bug fixes for the old major version for some time after releasing a new major version. We will not block community members from backporting other bugfixes and features from the latest stable version to older release branches, under the condition that these backports are of reasonable quality. Some changes may not be able to be backported.
 
-> Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible.
+Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible.

changelogs/changelog.yaml

@@ -41,3 +41,9 @@ releases:
     release_date: '2024-02-27'
   1.0.4:
     release_date: '2024-04-24'
+  1.0.5:
+    release_date: '2024-04-29'
+  1.0.6:
+    release_date: '2024-04-29'
+  1.0.7:
+    release_date: '2024-04-30'

docs/index.rst

@@ -1,11 +1,17 @@
-opsmill.infrahub Ansible Collection's documentation!
+opsmill.infrahub Ansible Collection documentation
 ================================================================
 
 
 Overview
 ========
 
-This is the documentation home of the **opsmill.infrahub** Ansible Collection. We will provide some examples of using all the different plugins included with this collection.
+`Infrahub <https://github.com/opsmill/infrahub>` by `OpsMill https://opsmill.com` acts as a central hub to manage all of the information and code that powers your infrastructure. At its heart, Infrahub is built on 3 fundamental pillars:
+
+* **A Flexible Schema**: A model of the infrastructure and the relation between the objects in the model, that's easily extensible.
+* **Version Control**: Natively integrated into the graph database which opens up some new capabilities like branching, diffing, and merging data directly in the database.
+* **Unified Storage**: By combining a graph database and git, Infrahub stores data and code needed to manage the infrastructure.
+
+This is the documentation home of the **opsmill.infrahub** Ansible Collection.
 
 Contents
 ========

docs/plugins/artifact_fetch_module.rst

@@ -6,34 +6,15 @@
 .. |antsibull-internal-nbsp| unicode:: 0xA0
     :trim:
 
-.. role:: ansible-attribute-support-label
-.. role:: ansible-attribute-support-property
-.. role:: ansible-attribute-support-full
-.. role:: ansible-attribute-support-partial
-.. role:: ansible-attribute-support-none
-.. role:: ansible-attribute-support-na
-.. role:: ansible-option-type
-.. role:: ansible-option-elements
-.. role:: ansible-option-required
-.. role:: ansible-option-versionadded
-.. role:: ansible-option-aliases
-.. role:: ansible-option-choices
-.. role:: ansible-option-choices-default-mark
-.. role:: ansible-option-default-bold
-.. role:: ansible-option-configuration
-.. role:: ansible-option-returned-bold
-.. role:: ansible-option-sample-bold
+.. meta::
+  :antsibull-docs: 2.10.0
 
 .. Anchors
 
 .. _ansible_collections.opsmill.infrahub.artifact_fetch_module:
 
 .. Anchors: short name for ansible.builtin
 
-.. Anchors: aliases
-
-
-
 .. Title
 
 opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from Infrahub
@@ -42,7 +23,10 @@ opsmill.infrahub.artifact_fetch module -- Fetch the content of an artifact from
 .. Collection note
 
 .. note::
-    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/opsmill/infrahub>`_ (version 1.0.4).
+    This module is part of the `opsmill.infrahub collection <https://galaxy.ansible.com/ui/repo/published/opsmill/infrahub/>`_ (version 1.0.6).
+
+    It is not included in ``ansible-core``.
+    To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
     To install it, use: :code:`ansible-galaxy collection install opsmill.infrahub`.
     You need further requirements to be able to use this module,
@@ -96,13 +80,13 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
-.. rst-class:: ansible-option-table
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
 
 .. list-table::
   :width: 100%
   :widths: auto
   :header-rows: 1
+  :class: longtable ansible-option-table
 
   * - Parameter
     - Comments
@@ -122,9 +106,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-api_endpoint" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string`
+        :ansible-option-type:`string`
 
       .. raw:: html
 
@@ -156,9 +140,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-artifact_name" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string` / :ansible-option-required:`required`
+        :ansible-option-type:`string` / :ansible-option-required:`required`
 
       .. raw:: html
 
@@ -190,9 +174,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-branch" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string`
+        :ansible-option-type:`string`
 
       .. raw:: html
 
@@ -228,9 +212,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-target_id" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string` / :ansible-option-required:`required`
+        :ansible-option-type:`string` / :ansible-option-required:`required`
 
       .. raw:: html
 
@@ -262,9 +246,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-timeout" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`integer`
+        :ansible-option-type:`integer`
 
       .. raw:: html
 
@@ -300,9 +284,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-token" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string`
+        :ansible-option-type:`string`
 
       .. raw:: html
 
@@ -334,9 +318,9 @@ Parameters
 
         <a class="ansibleOptionLink" href="#parameter-validate_certs" title="Permalink to this option"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`boolean`
+        :ansible-option-type:`boolean`
 
       .. raw:: html
 
@@ -411,12 +395,13 @@ Return Values
 -------------
 Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
 
-.. rst-class:: ansible-option-table
+.. tabularcolumns:: \X{1}{3}\X{2}{3}
 
 .. list-table::
   :width: 100%
   :widths: auto
   :header-rows: 1
+  :class: longtable ansible-option-table
 
   * - Key
     - Description
@@ -436,9 +421,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
 
         <a class="ansibleOptionLink" href="#return-json" title="Permalink to this return value"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`dictionary`
+        :ansible-option-type:`dictionary`
 
       .. raw:: html
 
@@ -476,9 +461,9 @@ Common return values are documented :ref:`here <common_return_values>`, the foll
 
         <a class="ansibleOptionLink" href="#return-text" title="Permalink to this return value"></a>
 
-      .. rst-class:: ansible-option-type-line
+      .. ansible-option-type-line::
 
-      :ansible-option-type:`string`
+        :ansible-option-type:`string`
 
       .. raw:: html
 
@@ -519,13 +504,18 @@ Authors
 Collection links
 ~~~~~~~~~~~~~~~~
 
-.. raw:: html
+.. ansible-links::
+
+  - title: "Issue Tracker"
+    url: "https://github.com/opsmill/infrahub-ansible/issues"
+    external: true
+  - title: "Homepage"
+    url: "https://www.opsmill.com/"
+    external: true
+  - title: "Repository (Sources)"
+    url: "https://github.com/opsmill/infrahub-ansible"
+    external: true
 
-  <p class="ansible-links">
-    <a href="https://github.com/opsmill/infrahub-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a>
-    <a href="https://www.opsmill.com/" aria-role="button" target="_blank" rel="noopener external">Homepage</a>
-    <a href="https://github.com/opsmill/infrahub-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a>
-  </p>
 
 .. Parsing errors
 

docs/plugins/environment_variables.rst

@@ -1,6 +1,9 @@
 
 :orphan:
 
+.. meta::
+  :antsibull-docs: 2.10.0
+
 .. _list_of_collection_env_vars:
 
 Index of all Collection Environment Variables
@@ -14,18 +17,18 @@ Environment variables used by the ansible-core configuration are documented in :
     Merge extra vars into the available variables for composition (highest precedence).
 
     *Used by:*
-    :ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`
+    :ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`
 .. envvar:: INFRAHUB_API
 
     Endpoint of the Infrahub API
 
     *Used by:*
-    :ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`,
-    :ref:`opsmill.infrahub.lookup lookup plugin <ansible_collections.opsmill.infrahub.lookup_lookup>`
+    :ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`,
+    :ansplugin:`opsmill.infrahub.lookup lookup plugin <opsmill.infrahub.lookup#lookup>`
 .. envvar:: INFRAHUB_TOKEN
 
     Infrahub API token to be able to read against Infrahub.
 
     *Used by:*
-    :ref:`opsmill.infrahub.inventory inventory plugin <ansible_collections.opsmill.infrahub.inventory_inventory>`,
-    :ref:`opsmill.infrahub.lookup lookup plugin <ansible_collections.opsmill.infrahub.lookup_lookup>`
+    :ansplugin:`opsmill.infrahub.inventory inventory plugin <opsmill.infrahub.inventory#inventory>`,
+    :ansplugin:`opsmill.infrahub.lookup lookup plugin <opsmill.infrahub.lookup#lookup>`