From 7ce598c630577dbad4f245f3c28f626f45070d8a Mon Sep 17 00:00:00 2001 From: Thomas Fargeix Date: Sun, 14 Jul 2024 22:24:12 +0200 Subject: [PATCH] Linting: Trim whitespace in docs and templates --- docs/data-model.md | 6 +++--- docs/index.md | 2 +- docs/installation-configuration.md | 6 +++--- docs/quick-start.md | 6 +++--- docs/security.md | 2 +- .../templates/netbox_data_flows/application.html | 2 +- .../templates/netbox_data_flows/applicationrole.html | 2 +- netbox_data_flows/templates/netbox_data_flows/dataflow.html | 2 +- .../templates/netbox_data_flows/dataflow_targets.html | 2 +- .../templates/netbox_data_flows/dataflowgroup.html | 2 +- .../netbox_data_flows/inc/objectaliastarget_actions.html | 2 +- .../templates/netbox_data_flows/objectalias.html | 2 +- 12 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/data-model.md b/docs/data-model.md index d0ecf18..b7c794b 100644 --- a/docs/data-model.md +++ b/docs/data-model.md @@ -36,7 +36,7 @@ It was decided not to use the native **Service** object: * The Service represents a TCP, SCTP or UDP listener and does not work as a possible Source for the data flow * It does not support other protocols, such as ICMP -* It is easy to combine a list of IP, prefixes and ranges, but combining them with a service (i.e.: a IP/protocol/port association) is much more complicated +* It is easy to combine a list of IP, prefixes and ranges, but combining them with a service (i.e.: a IP/protocol/port association) is much more complicated * Trying to bypass these limitations led to a technical implementation that was too complex and error-prone. To ease maintenance, the IP Addresses, IP Ranges and Prefixes are grouped in Object Aliases. These can be seen as reusable groups of addresses that can be a source or a destination to one or several data flows. @@ -66,7 +66,7 @@ Examples of applications: * MySuperBusinessApp * Network management * ... - + **Application Role** is a label to help you categorize your applications. Each Application may have one Application Role. @@ -80,7 +80,7 @@ Examples of roles: **Data Flows** modelize a network connection between two objects. They may be assigned to an Application. -Data Flows should have a source, a destination, a protocol, source ports and destination ports. Only the protocol is mandatory. +Data Flows should have a source, a destination, a protocol, source ports and destination ports. Only the protocol is mandatory. **Data Flow Groups** form a forest of groups. They can also be assigned to an Application. Data Flow Groups can be enabled and disabled and inherit the status of their parent. Disabled Data Flow Groups disable all the Data Flows contained within. diff --git a/docs/index.md b/docs/index.md index 96d83c6..75687bc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1 @@ -{% include-markdown "../README.md" %} \ No newline at end of file +{% include-markdown "../README.md" %} diff --git a/docs/installation-configuration.md b/docs/installation-configuration.md index 295c704..3316e78 100644 --- a/docs/installation-configuration.md +++ b/docs/installation-configuration.md @@ -19,7 +19,7 @@ Once installed, go to the [quick start guide](quick-start.md) to discover how to > Plugin versions before v1.0.0 can support earlier versions of NetBox. However, they are not supported and not recommended for production use. > [!WARNING] -> The plugin uses some classes that are not explicitely exported in +> The plugin uses some classes that are not explicitely exported in NetBox's plugin API, such as MPTT Tree-based models. Upward compatiblity is therefore not fully guaranteed. ### Dependencies @@ -37,7 +37,7 @@ The plugin is available at [PyPi](https://pypi.org/project/netbox-data-flows/). Add the Python package to your `local_requirements` file: ```bash -echo netbox-data-flows >> /opt/netbox/local_requirements.txt +echo netbox-data-flows >> /opt/netbox/local_requirements.txt ``` Enable the plugin in NetBox configuration: @@ -159,4 +159,4 @@ FIELD_CHOICES = { This syntax will add IGMP as a possible protocol in the drop list. -Full reference: [FIELD_CHOICES - NetBox Documentation](https://docs.netbox.dev/en/stable/configuration/data-validation/#field_choices) \ No newline at end of file +Full reference: [FIELD_CHOICES - NetBox Documentation](https://docs.netbox.dev/en/stable/configuration/data-validation/#field_choices) diff --git a/docs/quick-start.md b/docs/quick-start.md index 5900299..16c504f 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -20,7 +20,7 @@ Let's start by documenting the two data flow below: * The 3 frontend servers of Acme talk with the API exposed on the backend server * Both the frontend servers and the backend servers communicate with the database server. -There are two mandatory objects to do that: the Object Aliases and the Data Flows. +There are two mandatory objects to do that: the Object Aliases and the Data Flows. ### Object Aliases @@ -135,7 +135,7 @@ Applications can have: * Optional description and comments * Optional contacts in the Contacts tab. -| Name | Application role +| Name | Application role | --------------------- | --------------------- | | Acme Inc. website | Business applications | | Zabbix | Support applications | @@ -191,7 +191,7 @@ Data Flow Groups can have: The detail page of a group will list: * Its child groups -* The data flows it directly contains +* The data flows it directly contains * The data flows all its children contain ![The detail page of a group](media/tuto-dfg-details.png) diff --git a/docs/security.md b/docs/security.md index eadd8d0..6a09980 100644 --- a/docs/security.md +++ b/docs/security.md @@ -1 +1 @@ -{% include-markdown "../SECURITY.md" %} \ No newline at end of file +{% include-markdown "../SECURITY.md" %} diff --git a/netbox_data_flows/templates/netbox_data_flows/application.html b/netbox_data_flows/templates/netbox_data_flows/application.html index b13b371..288bfc0 100644 --- a/netbox_data_flows/templates/netbox_data_flows/application.html +++ b/netbox_data_flows/templates/netbox_data_flows/application.html @@ -64,4 +64,4 @@
{% trans "Data Flows" %}
{% plugin_full_width_page object %} -{% endblock content %} \ No newline at end of file +{% endblock content %} diff --git a/netbox_data_flows/templates/netbox_data_flows/applicationrole.html b/netbox_data_flows/templates/netbox_data_flows/applicationrole.html index 3dde1c8..dcc43b0 100644 --- a/netbox_data_flows/templates/netbox_data_flows/applicationrole.html +++ b/netbox_data_flows/templates/netbox_data_flows/applicationrole.html @@ -53,4 +53,4 @@
{% trans "Applications" %}
{% plugin_full_width_page object %} -{% endblock content %} \ No newline at end of file +{% endblock content %} diff --git a/netbox_data_flows/templates/netbox_data_flows/dataflow.html b/netbox_data_flows/templates/netbox_data_flows/dataflow.html index 835658a..caaab9d 100644 --- a/netbox_data_flows/templates/netbox_data_flows/dataflow.html +++ b/netbox_data_flows/templates/netbox_data_flows/dataflow.html @@ -108,4 +108,4 @@
{% trans "Children Data Flows" %}
{% plugin_full_width_page object %} -{% endblock content %} \ No newline at end of file +{% endblock content %} diff --git a/netbox_data_flows/templates/netbox_data_flows/dataflow_targets.html b/netbox_data_flows/templates/netbox_data_flows/dataflow_targets.html index 4a6dbc0..fbeeb74 100644 --- a/netbox_data_flows/templates/netbox_data_flows/dataflow_targets.html +++ b/netbox_data_flows/templates/netbox_data_flows/dataflow_targets.html @@ -55,4 +55,4 @@
{% trans "Destinations" %}
-{% endblock content %} \ No newline at end of file +{% endblock content %} diff --git a/netbox_data_flows/templates/netbox_data_flows/dataflowgroup.html b/netbox_data_flows/templates/netbox_data_flows/dataflowgroup.html index 64f1bef..5b17b8e 100644 --- a/netbox_data_flows/templates/netbox_data_flows/dataflowgroup.html +++ b/netbox_data_flows/templates/netbox_data_flows/dataflowgroup.html @@ -90,4 +90,4 @@
{% trans "Data Flows (child groups' members)" %}
{% plugin_full_width_page object %} -{% endblock content %} \ No newline at end of file +{% endblock content %} diff --git a/netbox_data_flows/templates/netbox_data_flows/inc/objectaliastarget_actions.html b/netbox_data_flows/templates/netbox_data_flows/inc/objectaliastarget_actions.html index fa4e68d..02f326d 100644 --- a/netbox_data_flows/templates/netbox_data_flows/inc/objectaliastarget_actions.html +++ b/netbox_data_flows/templates/netbox_data_flows/inc/objectaliastarget_actions.html @@ -5,4 +5,4 @@ -{% endif %} \ No newline at end of file +{% endif %} diff --git a/netbox_data_flows/templates/netbox_data_flows/objectalias.html b/netbox_data_flows/templates/netbox_data_flows/objectalias.html index 1525624..695dc93 100644 --- a/netbox_data_flows/templates/netbox_data_flows/objectalias.html +++ b/netbox_data_flows/templates/netbox_data_flows/objectalias.html @@ -76,4 +76,4 @@
{% trans "Destination in Data Flows" %}
{% plugin_full_width_page object %} -{% endblock content %} \ No newline at end of file +{% endblock content %}