[docs] Spell check

README.rst

@@ -62,7 +62,7 @@ Other popular building blocks that are part of the OpenWISP ecosystem are:
 - `openwisp-network-topology
   <https://openwisp.io/docs/dev/network-topology/>`_: provides way to
   collect and visualize network topology data from dynamic mesh routing
-  daemons or other network software (eg: OpenVPN); it can be used in
+  daemons or other network software (e.g.: OpenVPN); it can be used in
   conjunction with openwisp-monitoring to get a better idea of the state
   of the network
 - `openwisp-ipam <https://openwisp.io/docs/dev/ipam/>`_: allows to manage

docs/developer/extending.rst

@@ -45,9 +45,9 @@ Now, you need to do is to create some new django apps which will contain
 your custom version of *OpenWISP Controller*.
 
 A django project is a collection of django apps. There are 4 django apps
-in the openwisp_controller project, namely config, pki, connection & geo.
-You'll need to create 4 apps in your project for each app in
-openwisp_controller.
+in the openwisp_controller project, namely *config*, *pki*, *connection* &
+*geo*. You'll need to create 4 apps in your project for each app in
+*openwisp-controller*.
 
 A django app is nothing more than a `python package
 <https://docs.python.org/3/tutorial/modules.html#packages>`_ (a directory
@@ -199,7 +199,7 @@ Add ``openwisp_utils.loaders.DependencyLoader`` to ``TEMPLATES`` in your
 5. Initial Database Setup
 -------------------------
 
-Ensure you are using one of the available geodjango backends, eg:
+Ensure you are using one of the available geodjango backends, e.g.:
 
 .. code-block:: python
 

docs/developer/installation.rst

@@ -125,7 +125,7 @@ Alternative Sources
 Pypi
 ~~~~
 
-To install the latest stable version from pypi:
+To install the latest Pypi:
 
 .. code-block:: shell
 

docs/developer/utils.rst

@@ -238,8 +238,8 @@ It is not triggered when the device is created for the first time.
 
 - ``instance``: instance of ``Device`` which got registered.
 - ``is_new``: boolean, will be ``True`` when the device is new, ``False``
-  when the device already exists (eg: a device which gets a factory reset
-  will register again)
+  when the device already exists (e.g.: a device which gets a factory
+  reset will register again)
 
 This signal is emitted when a device registers automatically through the
 controller HTTP API.

docs/partials/developer-docs.rst

@@ -1,12 +1,9 @@
 .. note::
 
-    This documentation page is aimed at developers who want to customize,
-    change or extend the code of OpenWISP Controller in order to modify
-    its behavior (eg: for personal or commercial purposes or to fix a bug,
-    implement a new feature or contribute to the project in general).
+    This page is for developers who want to customize or extend OpenWISP
+    Controller, whether for bug fixes, new features, or contributions.
 
-    If you aren't a developer and you are looking for information on how
-    to use OpenWISP, please refer to:
+    For user guides and general information, please see:
 
     - :doc:`General OpenWISP Quickstart </user/quickstart>`
     - :doc:`OpenWISP Controller User Docs </controller/index>`

docs/user/intro.rst

@@ -29,11 +29,11 @@ following features:
 - :doc:`device-groups`: define different set of default configuration and
   metadata in device groups
 - :ref:`Template Tags <templates_tags>`: define different sets of default
-  templates (eg: mesh, WDS, 4G)
+  templates (e.g.: mesh, WDS, 4G)
 - **HTTP resources**: allow devices to automatically check for and
   download configuration updates
 - **VPN management**: automatically provision VPN tunnel configurations,
-  including cryptographic keys and IP addresses, eg: :doc:`OpenVPN
+  including cryptographic keys and IP addresses, e.g.: :doc:`OpenVPN
   </user/vpn>`, :doc:`WireGuard <wireguard>`
 - :doc:`import-export`
 
@@ -94,7 +94,7 @@ Geo App
 The geographic app is based on `django-loci
 <https://github.com/openwisp/django-loci>`_ and allows to define the
 geographic coordinates of the devices, as well as their indoor coordinates
-on floorplan images.
+on floor plan images.
 
 It exposes various :doc:`REST API endpoints <rest-api>`.
 

docs/user/openvpn.rst

@@ -141,7 +141,7 @@ Change your directory to ``/etc/easyrsa/pki/``.
 
 .. note::
 
-    If you incurr inthe following error: ``-bash: cd: /etc/easyrsa/pki:
+    If you incur in the following error: ``-bash: cd: /etc/easyrsa/pki:
     Permission denied``, you may need to log in as the root user.
 
 Import the CA

docs/user/push-operations.rst

@@ -106,7 +106,7 @@ Once you have performed the 3 steps above, you can test it as follows:
 
 1. Ensure there's at least one device turned on and connected to OpenWISP,
    ensure this device has the "SSH Authorized Keys" assigned to it.
-2. Ensure the celery worker of OpenWISP Controller is running (eg: ``ps
+2. Ensure the celery worker of OpenWISP Controller is running (e.g.: ``ps
    aux | grep celery``)
 3. SSH into the device and wait (maximum 2 minutes) until
    ``/etc/dropbear/authorized_keys`` appears as specified in the template.

docs/user/rest-api.rst

@@ -78,8 +78,8 @@ the ``status`` (e.g modified, applied, or error).
     GET /api/v1/controller/device/?config__status={status}
 
 You can filter a list of devices based on their configuration backend
-using the ``backend`` (e.g netjsonconfig.OpenWrt or
-netjsonconfig.OpenWisp).
+using the ``backend`` (e.g ``netjsonconfig.OpenWrt`` or
+``netjsonconfig.OpenWisp``).
 
 .. code-block:: text
 
@@ -111,7 +111,7 @@ You can filter a list of devices based on their device group using the
     GET /api/v1/controller/device/?group={group_id}
 
 You can filter a list of devices that have a device location object using
-the ``with_geo`` (eg. true or false).
+the ``with_geo`` (e.g. true or false).
 
 .. code-block:: text
 
@@ -361,7 +361,7 @@ the ``organization_id`` or ``organization_slug``.
     GET /api/v1/controller/group/?organization_slug={organization_slug}
 
 You can filter a list of device groups that have a device object using the
-``empty`` (eg. true or false).
+``empty`` (e.g. true or false).
 
 .. code-block:: text
 
@@ -440,7 +440,7 @@ You can create ``DeviceLocation`` object by using primary keys of existing
 
 **Note:** The ``indoor`` field represents the coordinates of the point
 placed on the image from the top left corner. E.g. if you placed the
-pointer on the top left corner of the floorplan image, its indoor
+pointer on the top left corner of the floor plan image, its indoor
 coordinates will be ``0,0``.
 
 .. code-block:: text
@@ -541,10 +541,10 @@ demonstrates creating both ``Location`` and ``FloorPlan`` objects.
         -F '[email protected]'
 
 **Note:** The request in above example uses ``multipart content-type`` for
-uploading floorplan image.
+uploading floor plan image.
 
-You can also use an existing ``Location`` object and create a new
-floorplan for that location using this endpoint.
+You can also use an existing ``Location`` object and create a new floor
+plan for that location using this endpoint.
 
 .. code-block:: text
 
@@ -667,9 +667,9 @@ Create Location
     POST /api/v1/controller/location/
 
 If you are creating an ``indoor`` location, you can use this endpoint to
-create floorplan for the location.
+create floor plan for the location.
 
-The following example demonstrates creating floorplan along with location
+The following example demonstrates creating floor plan along with location
 in a single request.
 
 .. code-block:: text
@@ -732,9 +732,9 @@ Change Location Details
 
     PUT /api/v1/controller/location/{pk}/
 
-**Note**: Only the first floorplan data present can be edited or changed.
-Setting the ``type`` of location to outdoor will remove all the floorplans
-associated with it.
+**Note**: Only the first floor plan data present can be edited or changed.
+Setting the ``type`` of location to outdoor will remove all the floor
+plans associated with it.
 
 Refer to the :ref:`examples in the "Create device location" section
 <create_device_location>` for information on payload format.
@@ -776,7 +776,7 @@ list location of devices from that organization.
 
     GET /api/v1/controller/location/geojson/?organization_slug={organization_slug}
 
-List Floorplans
+Floor Plan List
 ~~~~~~~~~~~~~~~
 
 .. code-block:: text
@@ -786,7 +786,7 @@ List Floorplans
 **Available filters**
 
 You can filter using ``organization_id`` or ``organization_slug`` to get
-list floorplans that belongs to an organization.
+list floor plans that belongs to an organization.
 
 .. code-block:: text
 
@@ -796,29 +796,29 @@ list floorplans that belongs to an organization.
 
     GET /api/v1/controller/floorplan/?organization_slug={organization_slug}
 
-Create Floorplan
-~~~~~~~~~~~~~~~~
+Create Floor Plan
+~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
     POST /api/v1/controller/floorplan/
 
-Get Floorplan Details
-~~~~~~~~~~~~~~~~~~~~~
+Get Floor Plan Details
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
     GET /api/v1/controller/floorplan/{pk}/
 
-Change Floorplan Details
-~~~~~~~~~~~~~~~~~~~~~~~~
+Change Floor Plan Details
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
     PUT /api/v1/controller/floorplan/{pk}/
 
-Delete floorplan
-~~~~~~~~~~~~~~~~
+Delete Floor Plan
+~~~~~~~~~~~~~~~~~
 
 .. code-block:: text
 
@@ -845,28 +845,28 @@ You can filter a list of templates based on their organization using the
     GET /api/v1/controller/template/?organization_slug={organization_slug}
 
 You can filter a list of templates based on their backend using the
-``backend`` (e.g netjsonconfig.OpenWrt or netjsonconfig.OpenWisp).
+``backend`` (e.g ``netjsonconfig.OpenWrt`` or ``netjsonconfig.OpenWisp``).
 
 .. code-block:: text
 
     GET /api/v1/controller/template/?backend={backend}
 
 You can filter a list of templates based on their type using the ``type``
-(eg. vpn or generic).
+(e.g. vpn or generic).
 
 .. code-block:: text
 
     GET /api/v1/controller/template/?type={type}
 
 You can filter a list of templates that are enabled by default or not
-using the ``default`` (eg. true or false).
+using the ``default`` (e.g. true or false).
 
 .. code-block:: text
 
     GET /api/v1/controller/template/?default={default}
 
 You can filter a list of templates that are required or not using the
-``required`` (eg. true or false).
+``required`` (e.g. true or false).
 
 .. code-block:: text
 
@@ -944,8 +944,8 @@ List VPNs
 **Available filters**
 
 You can filter a list of vpns based on their backend using the ``backend``
-(e.g openwisp_controller.vpn_backends.OpenVpn or
-openwisp_controller.vpn_backends.Wireguard).
+(e.g ``openwisp_controller.vpn_backends.OpenVpn`` or
+``openwisp_controller.vpn_backends.Wireguard``).
 
 .. code-block:: text
 

docs/user/settings.rst

@@ -160,8 +160,8 @@ A VPN backend must follow some basic rules in order to be compatible with
 
 - it MUST allow at minimum and at maximum one VPN instance
 - the main *NetJSON* property MUST match the lowercase version of the
-  class name, eg: when using the ``OpenVpn`` backend, the system will look
-  into ``config['openvpn']``
+  class name, e.g.: when using the ``OpenVpn`` backend, the system will
+  look into ``config['openvpn']``
 - it SHOULD focus on the server capabilities of the VPN software being
   used
 
@@ -288,7 +288,8 @@ The default value of the ``auto_cert`` field for new ``Template`` objects.
 
 The ``auto_cert`` field is valid only for templates which have ``type``
 set to ``VPN`` and indicates whether configuration regarding the VPN
-tunnel is provisioned automatically to each device using the template, eg:
+tunnel is provisioned automatically to each device using the template,
+e.g.:
 
 - when using OpenVPN, new `x509 <https://tools.ietf.org/html/rfc5280>`_
   certificates will be generated automatically using the same CA assigned
@@ -297,15 +298,15 @@ tunnel is provisioned automatically to each device using the template, eg:
   `Curve25519 <http://cr.yp.to/ecdh.html>`_) will be generated, as well as
   an IP address of the subnet assigned to the related VPN object
 - when using `VXLAN <https://tools.ietf.org/html/rfc7348>`_ tunnels over
-  Wireguad, in addition to the configuration generated for WireGuard, a
+  Wireguard, in addition to the configuration generated for Wireguard, a
   new VID will be generated automatically for each device if the
   configuration option "auto VNI" is turned on in the VPN object
 
 All these auto generated configuration options will be available as
 template variables.
 
 The objects that are automatically created will also be removed when they
-are not needed anymore (eg: when the VPN template is removed from a
+are not needed anymore (e.g.: when the VPN template is removed from a
 configuration object).
 
 ``OPENWISP_CONTROLLER_CERT_PATH``
@@ -316,7 +317,7 @@ configuration object).
 **default**: ``/etc/x509``
 ============ =============
 
-The filesystem path where x509 certificate will be installed when
+The file system path where x509 certificate will be installed when
 downloaded on routers when ``auto_cert`` is being used (enabled by
 default).
 
@@ -427,11 +428,11 @@ This feature is disabled by default.
 
 Options for the model field ``hardware_id``.
 
-- ``blank``: wether the field is allowed to be blank
-- ``null``: wether an empty value will be stored as ``NULL`` in the
+- ``blank``: whether the field is allowed to be blank
+- ``null``: whether an empty value will be stored as ``NULL`` in the
   database
 - ``max_length``: maximum length of the field
-- ``unique``: wether the value of the field must be unique
+- ``unique``: whether the value of the field must be unique
 - ``verbose_name``: text for the human readable label of the field
 - ``help_text``: help text to be displayed with the field
 
@@ -697,7 +698,7 @@ Allows to show a pie chart like the one in the screenshot.
     :alt: device groups piechart
 
 Active groups are groups which have at least one device in them, while
-emtpy groups do not have any device assigned.
+empty groups do not have any device assigned.
 
 ``OPENWISP_CONTROLLER_API_TASK_RETRY_OPTIONS``
 ----------------------------------------------

docs/user/subnet-division-rules.rst

@@ -63,7 +63,7 @@ VPN Subnet Division Rule
 This rule triggers when a template flagged as *VPN-client* is assigned to
 a device configuration, but only if the VPN server associated with the
 VPN-client template uses the same subnet to which the subnet division rule
-is assignated to.
+is assigned to.
 
 .. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/subnet-division-rule/subnet-division-rule.png
     :target: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/subnet-division-rule/subnet-division-rule.png

docs/user/variables.rst

@@ -100,7 +100,7 @@ The default values of variables can be manipulated from the section
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Predefined device variables, global variables and other variables that are
-automatically managed by the system (eg: when using templates of type
+automatically managed by the system (e.g.: when using templates of type
 VPN-client) are displayed in the admin UI as *System Defined Variables* in
 read-only mode.
 
@@ -150,7 +150,7 @@ These would be the default values in the template:
     }
 
 The default values can then be overridden at :ref:`device level
-<user_defined_variables>` if needed, eg:
+<user_defined_variables>` if needed, e.g.:
 
 .. code-block:: json
 

openwisp_controller/config/tests/test_api.py

@@ -287,7 +287,7 @@ def _assert_device_list_filter(response=None, device=None):
             r1 = self.client.get(f'{path}?config__templates={t1.pk}invalid_uuid')
             self.assertEqual(r1.status_code, 400)
             self.assertIn('Invalid UUID format', str(r1.content))
-            # test with comma seperated uuid's string
+            # test with comma separated uuid's string
             r2 = self.client.get(f'{path}?config__templates={t1.pk},{t2.pk}')
             self.assertEqual(r2.status_code, 400)
             self.assertIn('Invalid UUID format', str(r2.content))