feat(docs): add initial doc layout and CI jobs

!1

.gitlab-ci.yml

@@ -25,6 +25,7 @@ include:
     file:
       - .gitlab-ci_common.yaml
       - template/ansible-collection.gitlab-ci.yaml
+      - template/mkdocs-documentation.gitlab-ci.yaml
       # ToDo: update gitlabCI jobs for collections workflow
       - git_push_mirror/.gitlab-ci.yml
 

docs/projects/ansible/collection/phpipam_scan_agent/index.md

@@ -0,0 +1,45 @@
+---
+title: phpIPAM Scan Agent
+description: No Fuss Computings {php}IPAM Scan Agent for local and remote networks
+date: 2024-02-20
+template: project.html
+about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
+---
+
+<div align="center">
+
+![Project Status - Active](https://img.shields.io/badge/Project%20Status-Active-green?logo=gitlab&style=plastic)
+<br>
+[![Latest Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.highest_version.version&style=plastic&logo=ansible&logoColor=white&label=Latest%20Release&labelColor=black&color=cyan)](https://galaxy.ansible.com/ui/repo/published/nofusscomputing/ci_test_collection/)
+![Downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgalaxy.ansible.com%2Fapi%2Fv3%2Fplugin%2Fansible%2Fcontent%2Fpublished%2Fcollections%2Findex%2Fnofusscomputing%2Fphp_scan_agent%2F&query=%24.download_count&style=plastic&logo=ansible&logoColor=white&label=Downloads&labelColor=black&color=cyan)
+<br>
+[![Docker Image Version](https://img.shields.io/docker/v/nofusscomputing/phpipam-scan-agent?sort=semver&style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed&label=Latest%20Release)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
+[![Docker Pulls](https://img.shields.io/docker/pulls/nofusscomputing/phpipam-scan-agent?style=plastic&logo=docker&logoColor=0db7ed&color=0db7ed)](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent)
+
+</div>
+
+A phpIPAM scan agent designed for both local and remote network scanning. This Ansible Collection contains all of the componets required to launch a scan agent that will report back to the phpIPAM server. This collection is also built into it's own docker container and is [available on Docker Hub](https://hub.docker.com/r/nofusscomputing/phpipam-scan-agent).
+
+This collection has been broken down into two components, a server and a scanner. The scanner as the name implies will scan the networks assigned to it by phpIPAM and on completing a scan of a subnet, will post the results to the Server component which will process the results, and update the phpIPAM MySQL/MariaDB database directly.
+
+
+## Installation
+
+This collection is available on Ansible Galaxy and can be installed with `ansible-galaxy collection install nofusscomputing.phpipam_scan_agent`. When installing all of the required dependencies are installed.
+
+Prefer to use our docker image? It's available on Docker Hub `docker pull nofusscomputing/phpipam-scan-agent:latest`.
+
+
+## Features
+
+Currenty this collection has the following features:
+
+- Discover new hosts
+
+- [**ToDo** Hosts check](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/3)
+
+- [**ToDo** Host Self-Update](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/2)
+
+- [**ToDo** Remote Network Scanning](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/1)
+
+- [**ToDo** Resolve DNS names](https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/-/issues/4)

docs/projects/ansible/collection/phpipam_scan_agent/scanner.md

@@ -0,0 +1,48 @@
+---
+title: phpIPAM Scanner
+description: No Fuss Computings {php}IPAM Scan Agent scenner component
+date: 2024-02-20
+template: project.html
+about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
+---
+
+The Scan Agent Scanner component is intended to scan networks that are assigned to it by the phpIPAM server. It can be installed and ran from any host that is capable of running python.
+
+
+## Usage
+
+After installing the collection, running the agent is as simple as running the following command:
+
+``` bash
+
+ansible-playbook nofusscomputing.phpipam_scan_agent.agent \
+  --extra-vars "api_url=<your value here>" \
+  --extra-vars "client_token=<your value here>" \
+  --extra-vars "client_name=<your value here>" \
+  --extra-vars "scanagent_code=<your value here>"
+
+```
+_See below for the variable details_
+
+
+### Variables
+
+The variables described below, if optional the value specified here is the default value. Any variable that can be set via environmental variables have the variable name enclosed in `[]`
+
+``` yaml
+client_token: ""                       # Mandatory, String client api token to connect to phpIPAM API [SCANNER_TOKEN]
+client_name: ""                        # Mandatory, String. The scanner name as set in phpIPAM interface [SCANNER_NAME]
+scanagent_code: ""                     # Mandatory, String. Scan Agent Code as set in phpIPAM interface [SCANNER_CODE]
+
+
+nfc_c_http_port: 5000                  # Optional, Integer. http port to connect to the server. [HTTP_PORT]
+nfc_c_http_server: http://127.0.0.1    # Optional, Integer. url with protocol of the Scan Server to connect to. [HTTP_URL]
+
+
+api_url: http://127.0.0.1              # Optional, String. url with protocol of the phpIPAM API to connect to. [API_URL]
+
+
+nfc_c_cache_expire_time: 1800          # Optional, Integer. Time in seconds to expire the phpIPAM cache.
+nfc_c_epoch_time_offset: 0             # optional, int. Value in seconds to offset the time
+
+```

docs/projects/ansible/collection/phpipam_scan_agent/server.md

@@ -0,0 +1,11 @@
+---
+title: phpIPAM Scan Server
+description: No Fuss Computings {php}IPAM Scan Agent Server component
+date: 2024-02-20
+template: project.html
+about: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
+---
+
+The Scan Agent Server component is intended to act as the go between for the Scanner component and phpIPAM.
+
+## Usage

mkdocs.yml

@@ -0,0 +1,42 @@
+INHERIT: website-template/mkdocs.yml
+
+docs_dir: 'docs'
+
+repo_name: phpIPAM Scan Agent
+repo_url: https://gitlab.com/nofusscomputing/projects/ansible/collections/phpipam_scan_agent
+edit_uri: '/-/ide/project/nofusscomputing/projects/ansible/collections/phpipam_scan_agent/edit/development/-/docs/'
+
+nav:
+
+- Home: index.md
+
+- Articles: 
+
+  - articles/index.md
+
+- Projects: 
+
+  - projects/index.md
+
+  - Ansible:
+
+    - projects/ansible/index.md
+
+    - Collections: 
+
+      - docs/projects/ansible/collection/index.md
+
+      - phpIPAM Scan Agent:
+
+        - projects/ansible/collection/phpipam_scan_agent/index.md
+
+        - projects/ansible/collection/phpipam_scan_agent/scanner.md
+
+        - projects/ansible/collection/phpipam_scan_agent/server.md
+
+- Operations: 
+
+  - operations/index.md
+
+- Contact Us: contact.md
+