Skip to content

Commit

Permalink
[docs] Docs spell check
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Aug 6, 2024
1 parent d5083bf commit 7a7e514
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 46 deletions.
2 changes: 1 addition & 1 deletion docs/developer/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Clone ``ansible-openwisp2`` and ``Stouts.postfix`` as follows:
git clone https://github.com/Stouts/Stouts.postfix
git clone https://github.com/openwisp/ansible-ow-influxdb openwisp.influxdb
Now, go to the parent directory & create hosts file and playbook.yml:
Now, go to the parent directory & create hosts file and ``playbook.yml``:

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

This documentation page is aimed at developers who want to customize,
change or extend the code of Ansible OpenWISP2 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 the
Ansible role of OpenWISP, 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:`Ansible OpenWISP2 User Docs </ansible/index>`
2 changes: 1 addition & 1 deletion docs/user/configuring-cors-headers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ short summary of how to do this:
**Note:** to learn about the supported fields of the
``openwisp2_django_cors`` variable, look for the word
openwisp2_django_cors in the :doc:`role-variables` section of this
*"openwisp2_django_cors"* in the :doc:`role-variables` section of this
document.

**Step 5**: :ref:`Run the playbook <ansible_run_playbook>`
Expand Down
6 changes: 3 additions & 3 deletions docs/user/installing-on-vm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,10 @@ assign an IP address to the VM.
broadcast 192.168.56.255
Replace ``enp0s8`` with the network interface not present in the file
but is shown when running ``ls /sys/class/net``
but is shown when running ``ls /sys/class/net``.

- Save the file with CtrlO then Enter, and exit with CtrlX
- Restart the machine by running ``reboot``
- Save the file with *CTRL+O* then Enter, and exit with *CTRL+X*.
- Restart the machine by running ``reboot``.

Make sure you can access your VM via ssh:

Expand Down
17 changes: 9 additions & 8 deletions docs/user/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ First of all you need to understand two key concepts:
desktop computer!**) with public IpV4 / IPv6 which is used to host
OpenWISP
- for **“local machine”** we mean the host from which you launch ansible,
eg: your own laptop
e.g.: your own laptop

Ansible is a configuration management tool that works by entering
production servers via SSH, **so you need to install it and configure it
Expand All @@ -39,7 +39,7 @@ to the production server to install OpenWISP.
It is recommended to use this procedure on clean virtual machines or
linux containers.

If you are trying to install OpenWISP on your laptop or desktop pc
If you are trying to install OpenWISP on your laptop or desktop PC
just for testing purposes, please read :doc:`Install OpenWISP for
testing in a VirtualBox VM <./installing-on-vm>`.

Expand Down Expand Up @@ -93,7 +93,7 @@ configuration of OpenWISP.

This will be useful when you will need to upgrade OpenWISP.

Eg:
E.g.:

.. code-block:: shell
Expand All @@ -118,9 +118,9 @@ the following contents:
openwisp2.mydomain.com
Substitute ``openwisp2.mydomain.com`` with your **production server**'s
hostname - **DO NOT REPLACE ``openwisp2.mydomain.com`` WITH AN IP
ADDRESS**, otherwise email sending through postfix will break, causing 500
internal server errors on some operations.
hostname - **DO NOT REPLACE openwisp2.mydomain.com WITH AN IP ADDRESS**,
otherwise email sending through postfix will break, causing 500 internal
server errors on some operations.

.. _ansible_create_playbook_file:

Expand All @@ -141,7 +141,8 @@ the following contents:
The line ``become: "{{ become | default('yes') }}"`` means ansible will
use the ``sudo`` program to run each command. You may remove this line if
you don't need it (eg: if you are ``root`` user on the production server).
you don't need it (e.g.: if you are ``root`` user on the production
server).

You may replace ``openwisp2`` on the ``hosts`` field with your production
server's hostname if you desire.
Expand Down Expand Up @@ -289,7 +290,7 @@ Install requirements from the ``requirements.yml`` as follows
ansible-galaxy install -r requirements.yml
Now, create hosts file and playbook.yml:
Now, create hosts file and ``playbook.yml``:

.. code-block::
Expand Down
4 changes: 2 additions & 2 deletions docs/user/role-variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@ take a look at `the default values of these variables
# extra URL settings for django
openwisp2_extra_urls:
- "path(r'', include('my_custom_app.urls'))"
# allows to specify imports that are used in the websocket routes, eg:
# allows to specify imports that are used in the websocket routes, e.g.:
openwisp2_websocket_extra_imports:
- from my_custom_app.websockets.routing import get_routes as get_custom_app_routes
# allows to specify extra websocket routes, eg:
# allows to specify extra websocket routes, e.g.:
openwisp2_websocket_extra_routes:
# Callable that returns a list of routes
- get_custom_app_routes()
Expand Down
8 changes: 4 additions & 4 deletions docs/user/system-requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ variables which end with ``_concurrency`` or ``_autoscale`` in the
Software
--------

Generally a fresh installation of one of the supported operating systems
is sufficient; no pre-configuration required. The Ansible Playbook will
install and configure all dependencies and leave you with a running
OpenWISP installation.
A fresh installation of one of the supported operating systems is
generally sufficient, with no preconfiguration required. The Ansible
Playbook will handle the installation and configuration of all
dependencies, providing you with a fully operational OpenWISP setup.

.. important::

Expand Down
42 changes: 21 additions & 21 deletions docs/user/troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Troubleshooting
===============

OpenWISP is deployed using **uWSGI**, it also uses **daphne** fo
WebSockets and **celery** as task queue.
OpenWISP is deployed using **uWSGI** and also uses **daphne** for
WebSockets and **celery** as a task queue.

All this services are run by **supervisor**.
All these services are run by **supervisor**.

.. code-block:: shell
Expand All @@ -17,7 +17,7 @@ command:
sudo supervisorctl status
For more info about Supervisord, refer to `Running supervisorctl
For more information about Supervisord, refer to `Running supervisorctl
<http://supervisord.org/running.html#running-supervisorctl>`__.

The **nginx** web server sits in front of the **uWSGI** application
Expand All @@ -28,21 +28,21 @@ server. You can control nginx with the following commands:
service nginx status start|stop|status
OpenWISP is installed in ``/opt/openwisp2`` (unless you changed the
``openwisp2_path`` variable in the ansible playbook configuration), these
are some useful directories to look for when experiencing issues.
``openwisp2_path`` variable in the Ansible playbook configuration). These
are some useful directories to check when experiencing issues.

========================= ==========================
========================= ==============================
Location Description
========================= ==========================
/opt/openwisp2 The OpenWISP 2 root dir.
========================= ==============================
/opt/openwisp2 The OpenWISP 2 root directory.
/opt/openwisp2/log Log files
/opt/openwisp2/env Python virtual env
/opt/openwisp2/db.sqlite3 OpenWISP 2 sqlite database
========================= ==========================
/opt/openwisp2/env Python virtual environment
/opt/openwisp2/db.sqlite3 OpenWISP 2 SQLite database
========================= ==============================

All processes are running as ``www-data`` user.
All processes are running as the ``www-data`` user.

If you need to copy or edit files, you can switch to ``www-data`` user
If you need to copy or edit files, you can switch to the ``www-data`` user
with the following commands:

.. code-block:: shell
Expand All @@ -54,15 +54,15 @@ with the following commands:
SSL Certificate Gotchas
-----------------------

When you access the admin website you will get an SSL certificate warning
because the playbook creates a self-signed (untrusted) SSL certificate.
You can get rid of the warning by installing your own trusted certificate
and set the ``openwisp2_ssl_cert`` and ``openwisp2_ssl_key`` variables
accordingly or by following the instructions explained in the section
:doc:`certbot-ssl`.
When you access the admin website, you will receive an SSL certificate
warning because the playbook creates a self-signed (untrusted) SSL
certificate. You can get rid of the warning by installing your own trusted
certificate and setting the ``openwisp2_ssl_cert`` and
``openwisp2_ssl_key`` variables accordingly or by following the
instructions explained in the section :doc:`certbot-ssl`.

If you keep the untrusted certificate, you will also need to disable SSL
verification on devices using :doc:`openwisp-config
</openwrt-config-agent/index>` by setting ``verify_ssl`` to ``0``,
although we advice against using this kind of setup in a production
although we advise against using this kind of setup in a production
environment.

0 comments on commit 7a7e514

Please sign in to comment.