Skip to content

Commit

Permalink
Linting: Trim whitespace in docs and templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Alef-Burzmali committed Jul 18, 2024
1 parent cec70ce commit 7ce598c
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions docs/data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% include-markdown "../README.md" %}
{% include-markdown "../README.md" %}
6 changes: 3 additions & 3 deletions docs/installation-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down Expand Up @@ -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)
Full reference: [FIELD_CHOICES - NetBox Documentation](https://docs.netbox.dev/en/stable/configuration/data-validation/#field_choices)
6 changes: 3 additions & 3 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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 |
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/security.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{% include-markdown "../SECURITY.md" %}
{% include-markdown "../SECURITY.md" %}
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@ <h5 class="card-header">{% trans "Data Flows" %}</h5>
{% plugin_full_width_page object %}
</div>
</div>
{% endblock content %}
{% endblock content %}
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ <h5 class="card-header">{% trans "Applications" %}</h5>
{% plugin_full_width_page object %}
</div>
</div>
{% endblock content %}
{% endblock content %}
Original file line number Diff line number Diff line change
Expand Up @@ -108,4 +108,4 @@ <h5 class="card-header">{% trans "Children Data Flows" %}</h5>
{% plugin_full_width_page object %}
</div>
</div>
{% endblock content %}
{% endblock content %}
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,4 @@ <h5 class="card-header">{% trans "Destinations" %}</h5>
</div>
</div>
</div>
{% endblock content %}
{% endblock content %}
Original file line number Diff line number Diff line change
Expand Up @@ -90,4 +90,4 @@ <h5 class="card-header">{% trans "Data Flows (child groups' members)" %}</h5>
{% plugin_full_width_page object %}
</div>
</div>
{% endblock content %}
{% endblock content %}
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@
<a href="{% url 'plugins:netbox_data_flows:objectalias_removetarget' pk=objectalias.pk alias_pk=record.pk %}?return_url={% url 'plugins:netbox_data_flows:objectalias' pk=objectalias.pk %}" class="btn btn-danger lh-1" title="{% trans 'Unlink aliased object' %}">
<i class="mdi mdi-ethernet-cable-off"></i>
</a>
{% endif %}
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@ <h5 class="card-header">{% trans "Destination in Data Flows" %}</h5>
{% plugin_full_width_page object %}
</div>
</div>
{% endblock content %}
{% endblock content %}

0 comments on commit 7ce598c

Please sign in to comment.