From d97f8df06dfb7c7ec5fea06c835f755c2d65ad78 Mon Sep 17 00:00:00 2001 From: Marc Lebreuil Date: Sun, 5 Jan 2025 08:29:12 +0000 Subject: [PATCH 1/2] prepare 2.3.0 --- CHANGELOG.md | 3 +++ pyproject.toml | 2 +- src/netbox_contract/__init__.py | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c88021c..96a3f89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ ## Version 2 +### Version 2.3.0 + + ### Version 2.2.11 * [202](https://github.com/mlebreuil/netbox-contract/issues/202) Fix django.template.exceptions when trying to open device detail. diff --git a/pyproject.toml b/pyproject.toml index 8570dac..64dad03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "netbox-contract" -version = "2.2.11" +version = "2.3.0" authors = [ { name="Marc Lebreuil", email="marc@famillelebreuil.net" }, ] diff --git a/src/netbox_contract/__init__.py b/src/netbox_contract/__init__.py index 47d5f24..ab767bf 100644 --- a/src/netbox_contract/__init__.py +++ b/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 = 'marc@famillelebreuil.net' base_url = 'contracts' From c6961606e80aa3dcaac2b9a4222a05698cc63f09 Mon Sep 17 00:00:00 2001 From: Marc Lebreuil Date: Sun, 5 Jan 2025 08:51:31 +0000 Subject: [PATCH 2/2] update documentation --- CHANGELOG.md | 4 +++- docs/accounting_dimensions.md | 8 ++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 96a3f89..a75381d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ ### 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 @@ -36,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 diff --git a/docs/accounting_dimensions.md b/docs/accounting_dimensions.md index c64b7db..27dd06c 100644 --- a/docs/accounting_dimensions.md +++ b/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")