Merge pull request #54 from SummaCumWilly/docs-update

Documentation update

Author: cmeissner

CONTRIBUTING.md

@@ -1,41 +1,45 @@
 # How to contribute to phpipam-ansible-modules
 
-## Did you found a bug
+## Did you found a bug?
 
-* Do not open Github issue it the bug concerns [{php}IPAM](https://github.com/phpipam/phpipam) and not the ansible modules.
+* Do not open a Github issue if the bug concerns [{php}IPAM](https://github.com/phpipam/phpipam) and not the ansible modules.
 
 * Make sure the bug is not already opened by another user.
 
-* If you can't find an open issue which reflects your observed problem go ahead an [open a new bug](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
+* If you can't find an open issue which reflects your observed problem, go ahead and [open a new bug](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=bug&template=bug_report.md&title=).
 
 * Provide as much information as mentioned in the bug report template.
 
-## Did you wrote a patch for an open bug
+## Did you write a patch for an open bug?
 
 * Open new pull request containing the patch.
 
 * Provide a clear description which describes the problem and the solution. Link the existing bug to the PR.
 
-## Do you want to add a new feature
+## Do you want to add a new feature?
 
 * Make sure there isn't already a feature request.
 
-* If you can't find an open feature request which describe your feature idea or parts of it feel free to [open a new feature request](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
+* If you can't find an open feature request which describes your feature idea or parts of it, feel free to [open a new feature request](https://github.com/codeaffen/phpipam-ansible-modules/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=).
 
 * Suggest your feature idea within the created feature request.
 
-* Provide as much discribtion as possible to enable others to have a good understanding of what you are doing.
+* Provide as much description as possible to enable others to have a good understanding of what you are doing.
 
 * Point out that you want to start to work on the new feature
 
-## Do you wnat to contribute to documentation
+## Do you wnat to contribute to documentation?
 
-* Write you documentation change.
+* Fork me.
 
-* Open a PR with your change.
+* Create a documentation branch.
+
+* Write your documentation changes.
+
+* Open a PR with your changes.
 
 * Discuss with the team about your changes.
 
 ## Thank you for any contribution
 
-We will thank you for heed the contribution guidelines and we encourage you to contribute and join the team.
+We will thank you for heeding the contribution guidelines and we encourage you to contribute and join the team.

README.md

@@ -4,7 +4,7 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/0372c2bb95e845ce96fa5d4cf13ca1ca)](https://www.codacy.com/gh/codeaffen/phpipam-ansible-modules/dashboard?utm_source=github.com&utm_medium=referral&utm_content=codeaffen/phpipam-ansible-modules&utm_campaign=Badge_Grade)
 [![Documentation Status](https://readthedocs.org/projects/phpipam-ansible-modules/badge/?version=develop)](https://phpipam-ansible-modules.readthedocs.io/en/develop/?badge=develop)
 
-This collection provides modules to manage entities in a [phpIPAM](https://phpipam.net/). This is neighter a collection of roles nor playbooks. It provides modules to wrote your own roles and/or playbooks.
+This collection provides modules to manage entities in a [phpIPAM](https://phpipam.net/). This is neither a collection of roles nor playbooks. It provides modules to write your own roles and/or playbooks.
 
 We get a lot of inspiration from [foreman-ansible-modules](https://galaxy.ansible.com/theforeman/foreman) for our modules.
 

changelogs/fragments/docs-update.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - Minor formatting and spelling fixes.

docs/conf.py

@@ -20,7 +20,7 @@
 # -- Project information -----------------------------------------------------
 
 project = u'phpIPAM Ansible Modules'
-copyright = u'2020, codeaffen'
+copyright = u'2021, codeaffen'
 author = u'codeaffen'
 
 # The short X.Y version

docs/filters.rst

@@ -6,7 +6,7 @@ Filters are used to manipulate data if needed.
 is_subnet
 ---------
 
-This filter checks wether a given subnet belongs to the second one. It returns `true` if first subnet belongs to second and `false` if not or both subnets are the same.
+This filter checks whether a given subnet belongs to the second one. It returns `true` if first subnet belongs to the second and `false` if not, or if both subnets are the same.
 
 **since version:** 1.2.0
 

docs/plugins/address_module.rst

@@ -2,6 +2,16 @@
 
 :orphan:
 
+.. |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
+
 .. Anchors
 
 .. _ansible_collections.codeaffen.phpipam.address_module:
@@ -20,7 +30,7 @@ codeaffen.phpipam.address -- Manage addresses
 .. Collection note
 
 .. note::
-    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_.
+    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (version 1.3.1).
 
     To install it use: :code:`ansible-galaxy collection install codeaffen.phpipam`.
 
@@ -416,6 +426,9 @@ Parameters
                         </table>
     <br/>
 
+.. Attributes
+
+
 .. Notes
 
 
@@ -430,12 +443,13 @@ Examples
 .. code-block:: yaml+jinja
 
 
-    - name: "Reserve a IP address"
+    - name: "Reserve an IP address"
       codeaffen.phpipam.section:
         username: "admin"
         password: "s3cr3t"
         server_url: "https://ipam.example.com"
         address: "192.0.2.1"
+        section: "Customers"
         description: "Default router of sunet"
         subnet: "192.0.2.0/24"
         is_gateway: yes
@@ -448,6 +462,7 @@ Examples
         server_url: "https://ipam.example.com"
         address: "192.0.2.1"
         subnet: "192.0.2.0/24"
+        section: "Customers"
         state: absent
 
 

docs/plugins/device_module.rst

@@ -2,6 +2,16 @@
 
 :orphan:
 
+.. |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
+
 .. Anchors
 
 .. _ansible_collections.codeaffen.phpipam.device_module:
@@ -20,7 +30,7 @@ codeaffen.phpipam.device -- Manage devices
 .. Collection note
 
 .. note::
-    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_.
+    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (version 1.3.1).
 
     To install it use: :code:`ansible-galaxy collection install codeaffen.phpipam`.
 
@@ -438,9 +448,9 @@ Parameters
                                                                                                                                                             </td>
                                                                 <td>
                                             <div>Device type of this device.</div>
-                                            <div>The value have to reflect values from device types configured.</div>
+                                            <div>The value has to reflect values from device types configured.</div>
                                             <div>Default device types are <em>Switch</em>, <em>Router</em>, <em>Firewall</em>, <em>Hub</em>, <em>Wireless</em>, <em>Database</em>, <em>Workstation</em>, <em>Laptop</em> and <em>Other</em>.</div>
-                                            <div>User defined types can be created eigther via UI, API (e.g. <em>device_type</em> ansible module within this collection).</div>
+                                            <div>User defined types can be created either via UI, API (e.g. <em>device_type</em> ansible module within this collection).</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -480,6 +490,9 @@ Parameters
                         </table>
     <br/>
 
+.. Attributes
+
+
 .. Notes
 
 

docs/plugins/device_type_module.rst

@@ -2,6 +2,16 @@
 
 :orphan:
 
+.. |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
+
 .. Anchors
 
 .. _ansible_collections.codeaffen.phpipam.device_type_module:
@@ -20,7 +30,7 @@ codeaffen.phpipam.device_type -- Manage device types
 .. Collection note
 
 .. note::
-    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_.
+    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (version 1.3.1).
 
     To install it use: :code:`ansible-galaxy collection install codeaffen.phpipam`.
 
@@ -204,6 +214,9 @@ Parameters
                         </table>
     <br/>
 
+.. Attributes
+
+
 .. Notes
 
 

docs/plugins/domain_module.rst

@@ -2,6 +2,16 @@
 
 :orphan:
 
+.. |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
+
 .. Anchors
 
 .. _ansible_collections.codeaffen.phpipam.domain_module:
@@ -20,7 +30,7 @@ codeaffen.phpipam.domain -- Manage L2 routing domains
 .. Collection note
 
 .. note::
-    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_.
+    This plugin is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (version 1.3.1).
 
     To install it use: :code:`ansible-galaxy collection install codeaffen.phpipam`.
 
@@ -219,6 +229,9 @@ Parameters
                         </table>
     <br/>
 
+.. Attributes
+
+
 .. Notes
 
 

docs/plugins/index.rst

@@ -1,18 +1,23 @@
-:orphan:
 
 .. _plugins_in_codeaffen.phpipam:
 
-Plugin Index
-============
+Codeaffen.Phpipam
+=================
 
-These are the plugins in the codeaffen.phpipam collection
+Collection version 1.3.1
 
 .. toctree::
     :maxdepth: 1
 
 
+Plugin Index
+------------
+
+These are the plugins in the codeaffen.phpipam collection
+
+
 Modules
--------
+~~~~~~~
 
 * :ref:`address <ansible_collections.codeaffen.phpipam.address_module>` -- Manage addresses
 * :ref:`device <ansible_collections.codeaffen.phpipam.device_module>` -- Manage devices
@@ -25,6 +30,21 @@ Modules
 * :ref:`vrf <ansible_collections.codeaffen.phpipam.vrf_module>` -- Manage virtual routers and forwarders
 
 
+
 .. seealso::
 
-    List of :ref:`collections <list_of_collections>` with docs hosted here.
+    List of :ref:`collections <list_of_collections>` with docs hosted here.
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    address_module
+    device_module
+    device_type_module
+    domain_module
+    nameserver_module
+    section_module
+    subnet_module
+    vlan_module
+    vrf_module