Merge pull request #447 from nautobot/cs-docs-revamp

Docs Revamp

.gitignore

@@ -13,6 +13,9 @@ pb.*.yml
 .env
 invoke.yml
 
+# Ignore folder created by `invoke docs`
+collections/
+
 # https://github.com/ansible/ansible/issues/68499
 # ansible_collections/
 

.readthedocs.yml

@@ -1,13 +1,26 @@
 ---
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
 version: 2
-#sphinx:
-#  configuration: docs/conf.py
 
+# Set the version of Python in the build environment.
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-22.04"
   tools:
     python: "3.10"
+  jobs:
+    post_install:
+      - "ansible-galaxy collection install . --force"
+
+
+mkdocs:
+  configuration: "mkdocs.yml"
+  # fail_on_warning: true
 
+# Use our docs/requirements.txt during installation.
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: "docs/requirements.txt"

CHANGELOG.rst → CHANGELOG.md

@@ -1,9 +1,4 @@
-====================================
-networktocode.nautobot Release Notes
-====================================
-
-.. contents:: Topics
-
+# networktocode.nautobot Release Notes
 
 v5.3.1
 ======
@@ -114,7 +109,7 @@ v5.0.0
 Release Summary
 ---------------
 
-This release updates collection code for compatibility code with Nautobot 2.0, where API has breaking changes. 
+This release updates collection code for compatibility code with Nautobot 2.0, where API has breaking changes.
 
 Breaking Changes / Porting Guide
 --------------------------------

README.md

@@ -1,20 +1,27 @@
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+![https://github.com/nautobot/nautobot-ansible/actions](https://github.com/nautobot/nautobot-ansible/actions/workflows/trigger_scheduled.yml/badge.svg?branch=develop)
+![https://docs.nautobot.com/projects/ansible/en/latest/](https://readthedocs.org/projects/nautobot-ansible/badge/)
+![https://github.com/psf/black](https://img.shields.io/badge/code%20style-black-000000.svg)
 
-# Nautobot Modules for Ansible using Ansible Collections
+# Ansible Collection for Nautobot
 
-This collection provides Ansible modules to interact with Nautobot, an open-source Network Source of Truth and Network Automation Platform. The modules allow you to automate various tasks in Nautobot, such as managing devices, interfaces, IP addresses, and more. By using these modules, you can keep your Source of Truth (SOT) updated and ensure that your network data is accurate and consistent.
+
+This collection provides Ansible plugins (modules, inventory, lookup/filters) to interact with Nautobot, an open-source Network Source of Truth and Network Automation Platform. The plugins allow you to automate various tasks in Nautobot, such as managing devices, interfaces, IP addresses, and more. By using these plugins, you can keep your Source of Truth (SOT) updated and ensure that your network data is accurate and consistent.
 
 To keep the code simple, we only officially support the two latest releases of Nautobot and don't guarantee backwards compatibility beyond that.
 
+Full documentation for this App can be found over on the [Nautobot Docs](https://docs.nautobot.com) website:
+
+- [Plugins Reference](https://docs.nautobot.com/projects/ansible/en/latest/networktocode.nautobot/) - Documentation (parameters, examples, return values) for all plugins included in the collection.
+- [Installation Guide](https://docs.nautobot.com/projects/ansible/en/latest/getting_started/installation/)
+- [Release Notes](https://docs.nautobot.com/projects/ansible/en/latest/release_notes/)
+
 ## Requirements
 
 - Nautobot 1.0.0+ or the two latest Nautobot releases
 - Python 3.6+
 - Python modules: **pynautobot 2.x+**
 - Ansible 2.9+
-- Nautobot write-enabled token when using modules or read-only token for `lookup/inventory`
-
-We have a new docs site live that can be found [here](https://nautobot-ansible.readthedocs.io/en/latest/).
+- Nautobot write-enabled token when using `modules` or read-only token for `lookup/inventory`
 
 ## Keeping Your Source of Truth Updated
 
@@ -64,4 +71,4 @@ If backwards incompatible changes are necessary, we plan to deprecate the old be
 
 ## History
 
-> This is a fork of the netbox.netbox Ansible Galaxy collection found at [https://github.com/netbox-community/ansible_modules](https://github.com/netbox-community/ansible_modules) in February, 2021
+> This is a fork of the `netbox.netbox` Ansible Galaxy collection found at [https://github.com/netbox-community/ansible_modules](https://github.com/netbox-community/ansible_modules) in February, 2021.

ansible.cfg

@@ -1,5 +1,6 @@
 [defaults]
 force_valid_group_names = always
+collections_path = ./collections
 
 [inventory]
 enable_plugins = networktocode.nautobot.inventory, networktocode.nautobot.gql_inventory, yaml, ini