Skip to content

Commit

Permalink
[docs] Spell check
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Aug 6, 2024
1 parent be7243a commit 33ac32b
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 33 deletions.
5 changes: 2 additions & 3 deletions docs/developer/extending.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ resort to monkey patching, you can proceed as follows:
11. Create Root URL Configuration
---------------------------------

The following can be used to register all the urls in your
The following can be used to register all the URLs in your
``urls.py``.

Please read and replicate according to your project needs:
Expand Down Expand Up @@ -392,8 +392,7 @@ customization.
~~~~~~~~~~~~~~~~~~~~~~

Extending the views is only required when you want to make changes in the
behaviour of the API. Please refer to
`sample_network_topology/api/views.py
behavior of the API. Please refer to `sample_network_topology/api/views.py
<https://github.com/openwisp/openwisp-network-topology/tree/master/tests/openwisp2/sample_network_topology/api/views.py>`_
and replicate it in your application.

Expand Down
4 changes: 2 additions & 2 deletions docs/developer/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Run tests with:
# the following command
WIFI_MESH=1 ./runtests.py
Run qa tests:
Run QA tests:

.. code-block:: shell
Expand All @@ -97,7 +97,7 @@ Alternative Sources
Pypi
~~~~

To install the latest stable version from pypi:
To install the latest Pypi:

.. code-block:: shell
Expand Down
6 changes: 3 additions & 3 deletions docs/developer/overriding-visualizer-templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ Example: Overriding the ``<script>`` Tag

Here's a step by step guide on how to change the javascript options passed
to `netjsongraph.js <https://github.com/openwisp/netjsongraph.js>`_,
remember to replace ``<project_path>`` with the absolute filesytem path of
your project.
remember to replace ``<project_path>`` with the absolute file system path
of your project.

**Step 1**: create a directory in
``<project_path>/templates/netjsongraph``
Expand All @@ -43,7 +43,7 @@ setting so that it looks like the following example:
]
**Step 3**: create a new file named ``netjsongraph-script.html`` in the
new ``<project_path>/templates/netjsongraph/`` directory, eg:
new ``<project_path>/templates/netjsongraph/`` directory, e.g.:

.. code-block:: html

Expand Down
11 changes: 4 additions & 7 deletions docs/partials/developer-docs.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
.. note::

This documentation page is aimed at developers who want to customize,
change or extend the code of OpenWISP Network Topology 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
Network Topology, 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 Network Topology User Docs </network-topology/index>`
4 changes: 2 additions & 2 deletions docs/user/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In order to use this module simply add
.. code-block:: python
INSTALLED_APPS = [
# other apps (eg: openwisp-controller, openwisp-monitoring)
# other apps (e.g.: openwisp-controller, openwisp-monitoring)
"openwisp_network_topology",
"openwisp_network_topology.integrations.device",
"openwisp_users.accounts",
Expand Down Expand Up @@ -68,6 +68,6 @@ the ``CELERY_BEAT_SCHEDULE`` as follow:
},
}
If you are enabling this integration on a pre-existing system, use the
If you are enabling this integration on a preexisting system, use the
:ref:`create_device_nodes <network_topology_create_device_nodes>`
management command to create the relationship between devices and nodes.
10 changes: 5 additions & 5 deletions docs/user/management-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ graph:
./manage.py update_topology
The management command accepts a ``--label`` argument that will be used to
search in topology labels, eg:
search in topology labels, e.g.:

.. code-block::
Expand Down Expand Up @@ -47,7 +47,7 @@ in future:
./manage.py save_snapshot
The management command accepts a ``--label`` argument that will be used to
search in topology labels, eg:
search in topology labels, e.g.:

.. code-block::
Expand All @@ -67,7 +67,7 @@ instance:
The management command accepts an argument ``--backup``, that you can pass
to give the location of the backup files, by default it looks in the
``tests/`` directory, eg:
``tests/`` directory, e.g.:

.. code-block::
Expand All @@ -76,7 +76,7 @@ to give the location of the backup files, by default it looks in the
The management command accepts another argument ``--organization``, if you
want to import data to a specific organization, you can give its UUID for
the same, by default the data is added to the first found organization,
eg:
e.g.:

.. code-block::
Expand All @@ -93,7 +93,7 @@ django-netjsongraph

This management command can be used to create the initial ``DeviceNode``
relationships when the :doc:`integration with OpenWISP Controller
<integrations>` is enabled in a pre-existing system which already has some
<integrations>` is enabled in a preexisting system which already has some
devices and topology objects in its database.

.. code-block:: shell
Expand Down
6 changes: 3 additions & 3 deletions docs/user/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Quickstart Guide
================
Quick Start Guide
=================

This module works by periodically collecting the network topology graph
data of the :ref:`supported networking software or formats
Expand Down Expand Up @@ -53,7 +53,7 @@ Sending Data for Topology with RECEIVE Strategy
The topology receive URL is shown only after the topology object is
created.

2. Create a script (eg: ``/opt/send-topology.sh``) which sends the
2. Create a script (e.g.: ``/opt/send-topology.sh``) which sends the
topology data using ``POST``, in the example script below we are
sending the status log data of OpenVPN but the same code can be applied
to other formats by replacing ``cat /var/log/openvpn/tun0.stats`` with
Expand Down
15 changes: 7 additions & 8 deletions docs/user/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Additional custom `netdiff parsers
**default**: ``None``
============ ========

String representing python module to import on initialization.
String representing Python module to import on initialization.

Useful for loading django signals or to define custom behaviour.
Useful for loading Django signals or to define custom behavior.

``OPENWISP_NETWORK_TOPOLOGY_TIMEOUT``
-------------------------------------
Expand Down Expand Up @@ -81,7 +81,7 @@ user's preferences.
**default**: ``None``
============ ==========

Use the ``urlconf`` option to change receive api url to point to another
Use the ``urlconf`` option to change receive API URL to point to another
module, example, ``myapp.urls``.

``OPENWISP_NETWORK_TOPOLOGY_API_BASEURL``
Expand All @@ -92,11 +92,10 @@ module, example, ``myapp.urls``.
**default**: ``None``
============ ==========

If you have a seperate instance of openwisp-network-topology on a
different domain, you can use this option to change the base of the url,
this will enable you to point all the API urls to your
openwisp-network-topology API server's domain, example value:
``https://mytopology.myapp.com``.
If you have a separate instance of the OpenWISP Network Topology API on a
different domain, you can use this option to change the base of the URL,
this will enable you to point all the API URLs to your API server's
domain, example value: ``https://api.myservice.com``.

``OPENWISP_NETWORK_TOPOLOGY_API_AUTH_REQUIRED``
-----------------------------------------------
Expand Down

0 comments on commit 33ac32b

Please sign in to comment.