documentation update

Author: mzbroch

README.md

@@ -26,8 +26,10 @@ pip install ntc-netbox-plugin-onboarding
 systemctl restart netbox netbox-rq
 ```
 
-> The plugin is compatible with NetBox 2.8.1 and higher
- 
+> The ntc-netbox-plugin-onboarding v1.3 is compatible with NetBox 2.8
+
+> The ntc-netbox-plugin-onboarding v2 is compatible with NetBox 2.8 and NetBox 2.9
+
 To ensure NetBox Onboarding plugin is automatically re-installed during future upgrades, create a file named `local_requirements.txt` (if not already existing) in the NetBox root directory (alongside `requirements.txt`) and list the `ntc-netbox-plugin-onboarding` package:
 
 ```no-highlight
@@ -67,23 +69,29 @@ The plugin behavior can be controlled with the following list of settings
 - `platform_map` (dictionary), mapping of an **auto-detected** Netmiko platform to the **NetBox slug** name of your Platform. The dictionary should be in the format:
     ```python
     {
-      <Netmiko Platform>: <NetBox Slug> 
+      <Netmiko Platform>: <NetBox Slug>
+    }
+    ```
+- `onboarding_extensions_map` (dictionary), mapping of a NAPALM driver name to the loadable Python module used as an onboarding extension. The dictionary should be in the format:
+    ```python
+    {
+      <Napalm Driver Name>: <Loadable Python Module>
     }
     ```
 
 ## Usage
 
 ### Preparation
 
-To work properly the plugin needs to know the Site, Platform, Device Type, Device Role of each
-device as well as its primary IP address or DNS Name. It's recommended to create these objects in
-NetBox ahead of time and to provide them when you want to start the onboarding process.
+To properly onboard a device, the plugin needs to only know the Site as well as device's primary IP address or DNS Name.
 
 > For DNS Name Resolution to work, the instance of NetBox must be able to resolve the name of the
 > device to IP address.
 
+Providing other attributes (`Platform`, `Device Type`, `Device Role`) is optional - if any of these attributes is provided, plugin will use provided value for the onboarded device.
 If `Platform`, `Device Type` and/or `Device Role` are not provided, the plugin will try to identify these information automatically and, based on the settings, it can create them in NetBox as needed.
-> If the Platform is provided, it must contains a valid Napalm driver available to the worker in Python
+> If the Platform is provided, it must point to an existing NetBox Platform. NAPALM driver of this platform will be used only if it is defined for the platform in NetBox.
+> To use a preferred NAPALM driver, either define it in NetBox per platform or in the plugins settings under `platform_map`
 
 ### Onboard a new device
 

docs/release-notes/version-2.0.md

@@ -0,0 +1,24 @@
+# ntc-netbox-plugin-onboarding v2.0 Release Notes
+
+## v2.0
+
+### Enhancements
+
+* NetBox 2.9 support - Supported releases 2.8 and 2.9
+* Onboarding extensions - Customizable onboarding process through Python modules.
+* Onboarding details exposed in a device view - Date, Status, Last success and Latest task id related to the onboarded device are presented under the device view.
+* Onboarding task view - Onboarding details exposed in a dedicated view, including NetBox's ChangeLog.
+* Onboarding Changelog - Onboarding uses NetBox's ChangeLog to display user and changes made to the Onboarding Task object.
+* Skip onboarding feature - New attribute in the OnboardingDevice model allows to skip the onboarding request on devices with disabled onboarding setting.
+
+### Bug Fixes
+
+* Fixed race condition in `worker.py`
+* Improved logging
+
+### Additional Changes
+
+* Platform map now includes NAPALM drivers as defined in NetBox
+* Tests have been refactored to inherit NetBox's tests
+* Onboarding process will update the Device found by the IP-address lookup. In case of no existing device with onboarded IP-address is found in NetBox, onboarding might update the existing NetBox' looking up by network device's hostname.
+* Onboarding will raise Exception when `create_device_type_if_missing` is set to `False` for existing Device with DeviceType mismatch (behaviour pre https://github.com/networktocode/ntc-netbox-plugin-onboarding/issues/74)