Skip to content

Commit bb0aa80

Browse files
committed
[docs] Spell check
1 parent 457a040 commit bb0aa80

File tree

6 files changed

+18
-20
lines changed

6 files changed

+18
-20
lines changed

docs/developer/extending.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -273,8 +273,8 @@ For more information about URL configuration in django, please refer to
273273
the `"URL dispatcher" section in the django documentation
274274
<https://docs.djangoproject.com/en/4.2/topics/http/urls/>`_.
275275

276-
12. Create Celery.py
277-
--------------------
276+
12. Create ``celery.py``
277+
------------------------
278278

279279
Please refer to the `celery.py
280280
<https://github.com/openwisp/openwisp-firmware-upgrader/tree/master/tests/openwisp2/celery.py>`_

docs/partials/developer-docs.rst

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
.. note::
22

3-
This documentation page is aimed at developers who want to customize,
4-
change or extend the code of Firmware Upgrader in order to modify its
5-
behavior (eg: for personal or commercial purposes or to fix a bug,
6-
implement a new feature or contribute to the project in general).
3+
This page is for developers who want to customize or extend OpenWISP
4+
Firmware Upgrader, whether for bug fixes, new features, or
5+
contributions.
76

8-
If you aren't a developer and you are looking for information on how
9-
to use OpenWISP, please refer to:
7+
For user guides and general information, please see:
108

119
- :doc:`General OpenWISP Quickstart </user/quickstart>`
1210
- :doc:`Firmware Upgrader User Docs </docker/index>`

docs/user/intro.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Firmware Upgrader: Features
33

44
- Stores information of each upgrade operation which can be seen from the
55
device page
6-
- Automatic retries for recoverable failures (eg: firmware image upload
6+
- Automatic retries for recoverable failures (e.g.: firmware image upload
77
issues because of intermittent internet connection)
88
- Performs a final check to find out if the upgrade completed successfully
99
or not

docs/user/quickstart.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Quickstart Guide
2-
================
1+
Quick Start Guide
2+
=================
33

44
.. contents:: **Table of contents**:
55
:depth: 2
@@ -25,7 +25,7 @@ one firmware type in your network, you could simply name the category
2525
:target: https://raw.githubusercontent.com/openwisp/openwisp-firmware-upgrader/docs/docs/images/quickstart-category.gif
2626

2727
If you use multiple firmware images with different features, create one
28-
category for each firmware type, eg:
28+
category for each firmware type, e.g.:
2929

3030
- WiFi
3131
- SDN router
@@ -52,7 +52,7 @@ differences between each version.
5252

5353
An important but optional field of the build model is **OS identifier**,
5454
this field should match the value of the **Operating System** field which
55-
gets automatically filled during device registration, eg: ``OpenWrt
55+
gets automatically filled during device registration, e.g.: ``OpenWrt
5656
19.07-SNAPSHOT r11061-6ffd4d8a4d``. It is used by the firmware-upgrader
5757
module to automatically create ``DeviceFirmware`` objects for existing
5858
devices or when new devices register. A ``DeviceFirmware`` object

docs/user/rest-api.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ paginating the results in conjunction with the ``page`` parameter.
5454
Filtering by Organization Slug
5555
------------------------------
5656

57-
Most endpoints allow to filter by organization slug, eg:
57+
Most endpoints allow to filter by organization slug, e.g.:
5858

5959
.. code-block:: text
6060

docs/user/settings.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Settings
2525
Retry settings for recoverable failures during firmware upgrades.
2626

2727
By default if an upgrade operation fails before the firmware is flashed
28-
(eg: because of a network issue during the upload of the image), the
28+
(e.g.: because of a network issue during the upload of the image), the
2929
upgrade operation will be retried 4 more times with an exponential random
3030
backoff and a maximum delay of 10 minutes.
3131

@@ -98,7 +98,7 @@ in upgrades.
9898
============ ============================
9999

100100
This setting can be used to set the maximum size limit for firmware
101-
images, eg:
101+
images, e.g.:
102102

103103
.. code-block:: python
104104
@@ -128,7 +128,7 @@ Indicates whether the API for Firmware Upgrader is enabled or not.
128128
**default**: ``{}``
129129
============ ========
130130

131-
Allows changing the default OpenWrt upgrader settings, eg:
131+
Allows changing the default OpenWrt upgrader settings, e.g.:
132132

133133
.. code-block:: python
134134
@@ -160,10 +160,10 @@ Allows changing the default OpenWrt upgrader settings, eg:
160160
**default**: ``/`` (points to same server)
161161
============ =============================
162162

163-
If you have a seperate instance of openwisp-firmware-upgrader API on a
163+
If you have a separate instance of OpenWISP Firmware Upgrader API on a
164164
different domain, you can use this option to change the base of the image
165-
download url, this will enable you to point to your API server's domain,
166-
example value: ``https://myfirmware.myapp.com``.
165+
download URL, this will enable you to point to your API server's domain,
166+
e.g.: ``https://api.myservice.com``.
167167

168168
.. _openwisp_firmware_upgraders_map:
169169

0 commit comments

Comments
 (0)