Merge pull request #205 from mlebreuil/develop

update documentation

CHANGELOG.md

@@ -5,6 +5,11 @@
 
 ## Version 2
 
+### Version 2.3.0
+
+> [!WARNING]
+> Accounting dimension json field will be removed. It is deprecated since v2.2.0. Refer to the [documentation](https://mlebreuil.github.io/netbox-contract/accounting_dimensions/)
+
 ### Version 2.2.11
 
 * [202](https://github.com/mlebreuil/netbox-contract/issues/202) Fix django.template.exceptions when trying to open device detail.
@@ -33,7 +38,7 @@
 * Generally improve filtering options
 * [178](https://github.com/mlebreuil/netbox-contract/issues/178) Add the possibility to filter on invoice number, and contract name through the API.
 * [176](https://github.com/mlebreuil/netbox-contract/issues/176) Order accounting dimensions in tables alphabetically.
-* [171](https://github.com/mlebreuil/netbox-contract/issues/171) It is now poaaible to define madatory accounting dimension by specifying their names in the 'mandatory_dimensions' list in the plugin settings. (see the "Customize the plugin" paragraph in the README.md file)
+* [171](https://github.com/mlebreuil/netbox-contract/issues/171) It is now possible to define madatory accounting dimension by specifying their names in the 'mandatory_dimensions' list in the plugin settings. (see the "Customize the plugin" paragraph in the README.md file)
 
 ### Version 2.2.4
 

docs/accounting_dimensions.md

@@ -1,7 +1,7 @@
 # Accounting dimensions
 
-> [!NOTE]
-> account is considered a accounting dimensions as any other.
+!!! note
+    account is considered a accounting dimensions as any other.
 
 It is possible through the plugin config  attribure 'mandatory_dimensions' to set some mandatory dimensions. the attribute will take a list of dimension names. For instance:
 
@@ -22,8 +22,8 @@ PLUGINS_CONFIG = {
 
 Refer to the readme file for more information.
 
-> [!WARNING]
-> Accounting dimensions used to be set with a simple json field. Although the field is still available, it is recommended to add dimensions through invoice lines. You will find in the script folder a file which can be imported as netbox custom scripts module which contains a script to perform the migration. You wil need to adjust the script to your needs.
+!!! warning
+    Accounting dimensions used to be set with a simple json field. Although the field is still available, it is recommended to add dimensions through invoice lines. You will find in the script folder a file which can be imported as netbox custom scripts module which contains a script to perform the migration. You wil need to adjust the script to your needs.
 
 
 ![Accounting dimensions](img/accounting_dimensions.png "accounting dimensions")

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "netbox-contract"
-version = "2.2.11"
+version = "2.3.0"
 authors = [
   { name="Marc Lebreuil", email="[email protected]" },
 ]

src/netbox_contract/__init__.py

@@ -5,7 +5,7 @@ class ContractsConfig(PluginConfig):
     name = 'netbox_contract'
     verbose_name = 'Netbox contract'
     description = 'Contract management plugin for Netbox'
-    version = '2.2.11'
+    version = '2.3.0'
     author = 'Marc Lebreuil'
     author_email = '[email protected]'
     base_url = 'contracts'