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 8445dc0 commit 5c49a21
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 24 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Other changes
configuration is not present yet
- Increased report status retries: in some cases the report status
operation may fail because the network reload could take a few minutes
to complete (eg: in mesh networks scenarios) and therefore the agent
to complete (e.g.: in mesh networks scenarios) and therefore the agent
must be a bit more patient before giving up
- Refactored init script to make it more consistent with the best
practices used in the OpenWrt community
Expand Down Expand Up @@ -251,7 +251,7 @@ Bugfixes
- `#11 <https://github.com/openwisp/openwisp-config/issues/11>`_: added
``merge_default`` feature
- `#12 <https://github.com/openwisp/openwisp-config/issues/12>`_: improved
syslog facility and level (eg: daemon.info)
syslog facility and level (e.g.: daemon.info)
- `#14 <https://github.com/openwisp/openwisp-config/issues/14>`_:
resilient register failure
- `#13 <https://github.com/openwisp/openwisp-config/issues/13>`_: smarter
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ You can run all the unit tests by launching the dedicated script:
./runtests
Alternatively, you can run specifc tests, eg:
Alternatively, you can run specific tests, e.g.:

.. code-block:: shell
Expand Down
9 changes: 3 additions & 6 deletions docs/partials/developer-docs.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
.. note::

This documentation page is aimed at developers who want to customize,
change or extend the code of OpenWISP Config 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
Config, 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 Config User Docs </openwrt-config-agent/index>`
2 changes: 1 addition & 1 deletion docs/user/hotplug-events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The agent sends the following `Hotplug events

- After the registration is successfully completed: ``post-registration``
- After the registration failed: ``registration-failed``
- When the agent first starts after the bootup of the device: ``bootup``
- When the agent first starts after the booting process: ``bootup``
- After any subsequent restart: ``restart``
- After the configuration has been successfully applied:
``config-applied``
Expand Down
2 changes: 1 addition & 1 deletion docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Uncomment and change the following fields:

- ``url``: the hostname of your OpenWISP controller. For example, if you
are hosting your OpenWISP server locally and set the IP Address to
"192.168.56.2", the url would be ``https://192.168.56.2``.
"192.168.56.2", the URL would be ``https://192.168.56.2``.
- ``verify_ssl``: set to ``'0'`` if your controller's SSL certificate is
self-signed; in production, you need a valid SSL certificate to keep
your instance secure.
Expand Down
16 changes: 8 additions & 8 deletions docs/user/settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Configuration Options

UCI configuration options must go in ``/etc/config/openwisp``.

- ``url``: url of controller, eg: ``https://demo.openwisp.io``
- ``url``: URL of controller, e.g.: ``https://demo.openwisp.io``
- ``interval``: time in seconds between checks for changes to the
configuration, defaults to ``120``
- ``management_interval``: time in seconds between the management ip
Expand Down Expand Up @@ -44,8 +44,8 @@ UCI configuration options must go in ``/etc/config/openwisp``.
:ref:`config_hardware_id`
- ``hardware_id_key``: whether to use the hardware id for key generation
or not, defaults to ``1``
- ``bootup_delay``: maximum value in seconds of a random delay after
bootup, defaults to ``10``, see :ref:`config_bootup_delay`
- ``bootup_delay``: maximum value in seconds of a random delay after boot,
defaults to ``10``, see :ref:`config_bootup_delay`
- ``unmanaged``: list of config sections which won't be overwritten, see
:ref:`config_unmanaged_configuration`
- ``capath``: value passed to curl ``--capath`` argument, by default is
Expand Down Expand Up @@ -182,8 +182,8 @@ See also the :ref:`related hardware ID settings in OpenWISP Controller

.. _config_bootup_delay:

Bootup Delay
------------
Boot Up Delay
-------------

The option ``bootup_delay`` is used to delay the initialization of the
agent for a random amount of seconds after the device boots.
Expand All @@ -196,7 +196,7 @@ the agent will be delayed for a random number of seconds, this random
number being comprised between ``0`` and ``10``.

This feature is used to spread the load on the OpenWISP server when a
large amount of devices boot up at the same time after a blackout.
large amount of devices boot at the same time after a blackout.

Large OpenWISP installations may want to increase this value.

Expand All @@ -207,7 +207,7 @@ Hooks

.. warning::

Hooks are deprecated in favour of :doc:`Hotplug events
Hooks are deprecated in favor of :doc:`Hotplug events
<hotplug-events>`.

Below are described the available hooks in *openwisp-config*.
Expand All @@ -228,7 +228,7 @@ but **before services are reloaded**, more precisely in these situations:
and a previous backup is restored

You can use this hook to perform custom actions before services are
reloaded, eg: to perform auto-configuration with `LibreMesh
reloaded, e.g.: to perform auto-configuration with `LibreMesh
<http://libre-mesh.org/>`_.

Example configuration:
Expand Down
2 changes: 1 addition & 1 deletion openwisp-config/files/openwisp.agent
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ register() {
# exit if response does not seem to come from openwisp controller
check_header $REGISTRATION_PARAMETERS
if ! is_http_status $REGISTRATION_PARAMETERS 201; then
# get body of failure response, seperated from header by a blank line (CRLF-ended)
# get body of failure response, separated from header by a blank line (CRLF-ended)
message=$(awk 'BEGIN{RS="\r\n\r\n"}{if(NR>1)print $0}' $REGISTRATION_PARAMETERS)
logger -s "Registration failed! $message" \
-t openwisp \
Expand Down
2 changes: 1 addition & 1 deletion openwisp-config/files/sbin/openwisp-update-config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ for file, bool in pairs(added) do
end
end

-- restore pre-existing files that were changed via openwisp
-- restore preexisting files that were changed via openwisp
-- which are not present anymore
for file, bool in pairs(modified) do
local remote_path = remote_dir .. file
Expand Down
2 changes: 1 addition & 1 deletion openwisp-config/tests/test_update_bad_config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TestBrokenConfig = {
os.execute('mkdir -p ' .. remote_config_dir)
-- prepare bad config tar gz
os.execute('cp bad-config.tar.gz configuration.tar.gz')
-- these files are pre-existing on the device
-- these files are preexisting on the device
os.execute('cp ./update/system ' .. remote_config_dir .. '/system')
os.execute('cp ./update/system ' .. config_dir .. '/system')
os.execute('cp ./restore/network ' .. remote_config_dir .. '/network')
Expand Down
2 changes: 1 addition & 1 deletion openwisp-config/tests/test_update_bug_missing_file.lua
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ TestConfigMissingFile = {
os.execute('mkdir -p ' .. remote_config_dir)
-- prepare bad config tar gz
os.execute('cp good-config-missing-file-bug.tar.gz configuration.tar.gz')
-- these files are pre-existing on the device
-- these files are preexisting on the device
os.execute('cp ./update/system ' .. remote_config_dir .. '/system')
os.execute('cp ./update/system ' .. config_dir .. '/system')
os.execute('cp ./restore/network ' .. remote_config_dir .. '/network')
Expand Down
2 changes: 1 addition & 1 deletion openwisp-config/tests/test_update_config.lua
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ TestUpdateConfig = {
os.execute('mkdir -p ' .. remote_config_dir)
-- prepare config tar gz
os.execute('cp good-config.tar.gz configuration.tar.gz')
-- this file is pre-existing on the device
-- this file is preexisting on the device
os.execute('cp ./update/system '..config_dir..'system')
os.execute('cp ./update/network '..config_dir..'network')
os.execute('cp ./update/wireless '..config_dir..'wireless')
Expand Down

0 comments on commit 5c49a21

Please sign in to comment.