Merge pull request #6 from jonasnieberle/develope

change main readme and link to official documentation

README.md

@@ -1,44 +1,20 @@
+> [!CAUTION]
+> This plugin is still in development! 
+> Currently not yet ready for production use!
+
 # Netbox Operating System Management
 
-[NetBox](https://github.com/netbox-community/netbox) plugin to manage operating systems on your cisco devices in following aspects:
+[NetBox](https://github.com/netbox-community/netbox) plugin to manage operating systems on your cisco network devices in following aspects:
 
 - assign golden images based on filter attributes like device types, site, location, role
 - scheduled upload of the golden image to the device
 - scheduled upgrade of the device with pre- and post checks
 
+Official Documentation: https://jonasnieberle.github.io/netbox-os-manager
+
 ## Important notes
 
 Thank you to the allready existing [Cisco device software manager](https://github.com/alsigna/netbox-software-manager) for the inspiration. 
 Unfortunately the plugin has it's last update on January 2023.
 
-Use this plugin on your own risk! Test the update proccess in a test environment before you switch to your prod environment!
-
-## Image Upload
-
-### Image Upload - Architecture
-
-![Image Upload Architecture](./docs/diagrams/image_upload_architecture.drawio.svg)
-
-### Image Upload - Process
-
-![Image Upload Process](./docs/diagrams/image_upload_process.drawio.svg)
-
-## Image Upgrade
-
-### Image Add - Architecture
-
-![Image Add Architecture](./docs/diagrams/image_add_architecture.drawio.svg)
-
-### Image Add - Process
-
-![Image Add Process](./docs/diagrams/image_add_process.drawio.svg)
-
-### Image Activation
-
-### Image Activation - Architecture
-
-![Image Activation Architecture](./docs/diagrams/image_activation_architecture.drawio.svg)
-
-### Image Activation - Process
-
-![Image Activation Process](./docs/diagrams/image_activation_process.drawio.svg)
+Use this plugin on your own risk! Test the update proccess in a test environment before you switch to your prod environment!

docs/index.md

@@ -1,3 +1,44 @@
-{%
-    include-markdown "../README.md"
-%}
+# Netbox Operating System Management
+
+[NetBox](https://github.com/netbox-community/netbox) plugin to manage operating systems on your cisco devices in following aspects:
+
+- assign golden images based on filter attributes like device types, site, location, role
+- scheduled upload of the golden image to the device
+- scheduled upgrade of the device with pre- and post checks
+
+## Important notes
+
+Thank you to the allready existing [Cisco device software manager](https://github.com/alsigna/netbox-software-manager) for the inspiration. 
+Unfortunately the plugin has it's last update on January 2023.
+
+Use this plugin on your own risk! Test the update proccess in a test environment before you switch to your prod environment!
+
+## Image Upload
+
+### Image Upload - Architecture
+
+![Image Upload Architecture](./docs/diagrams/image_upload_architecture.drawio.svg)
+
+### Image Upload - Process
+
+![Image Upload Process](./docs/diagrams/image_upload_process.drawio.svg)
+
+## Image Upgrade
+
+### Image Add - Architecture
+
+![Image Add Architecture](./docs/diagrams/image_add_architecture.drawio.svg)
+
+### Image Add - Process
+
+![Image Add Process](./docs/diagrams/image_add_process.drawio.svg)
+
+### Image Activation
+
+### Image Activation - Architecture
+
+![Image Activation Architecture](./docs/diagrams/image_activation_architecture.drawio.svg)
+
+### Image Activation - Process
+
+![Image Activation Process](./docs/diagrams/image_activation_process.drawio.svg)