[PATCH 1/6] docs: Fix spelling mistakes and typos
eric at engestrom.ch
Mon May 2 19:08:27 AEST 2016
Signed-off-by: Eric Engestrom <eric at engestrom.ch>
docs/api.md | 2 +-
docs/contributing.md | 4 ++--
docs/deployment.md | 4 ++--
docs/development.md | 6 +++---
docs/upgrading.md | 8 ++++----
5 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/docs/api.md b/docs/api.md
index b7164a5..cfa5acf 100644
@@ -23,7 +23,7 @@ functionality.
You need to connect to the server. Some methods require authentication (via
HTTP Basic Auth) while others do not. Authentication uses your Patchwork
-account and the on-server documention will indicate where it is necessary.
+account and the on-server documentation will indicate where it is necessary.
We will only cover the unauthenticated method here for brevity - please
consult the [`xmlrpclib`] documentation for more detailed examples:
diff --git a/docs/contributing.md b/docs/contributing.md
index fc70301..93b0602 100644
@@ -6,7 +6,7 @@
Changes that fix semantic issues will be generally be happily received, but
-please keep such changes seperate from functional changes.
+please keep such changes separate from functional changes.
`pep8` targets are provided via tox. Refer to the [testing section](#testing)
below for more information on usage of this tool.
@@ -47,7 +47,7 @@ will do this:
All patches should be sent to the [mailing list][pw-ml]. When doing so, please
abide by the [QEMU guidelines][ref-qemu-contrib] on contributing or submitting
patches. This covers both the initial submission and any follow up to the
-patches. In particulat, please ensure:
+patches. In particular, please ensure:
* [All tests pass](#testing)
* Documentation has been updated with new requirements, new script names etc.
diff --git a/docs/deployment.md b/docs/deployment.md
index e8dcd0f..73282f9 100644
@@ -216,7 +216,7 @@ the file:
### Final Steps
-Once done, we should be able to check that all requirements are met using the
+Once done, we should be able to check that all requirements are met using
the `check` command of the `manage.py` executable:
$ /opt/patchwork/manage.py check
@@ -369,7 +369,7 @@ latter and they can be loaded as seen below:
**NOTE:** This assumes your Postfix process is running as the `nobody` user.
If this is not correct (use of `postfix` user is also common), you should
change both the username in the `createuser` command above and substitute the
-username in the the `grant-all-postgres.sql` script with the appropriate
+username in the `grant-all-postgres.sql` script with the appropriate
diff --git a/docs/development.md b/docs/development.md
index ddfbcb4..de5dac5 100644
@@ -14,7 +14,7 @@ The latest version of Patchwork is available with git. To download:
## Vagrant-Based Installation
Patchwork provides a Vagrantfile that can be used to quickly configure
-Patchwork in a delopment environment. Like any Vagrant VM, you can start this
+Patchwork in a development environment. Like any Vagrant VM, you can start this
using the `vagrant up` command:
$ cd patchwork # the path to the repo you cloned above
@@ -96,7 +96,7 @@ the above command.
## Configure Virtual Environment
**NOTE:** If you are interested in simply [testing Patchwork][doc-testing],
-many of the the below steps are not required. tox will automatically install
+many of the below steps are not required. tox will automatically install
dependencies and use virtual environments when testing.
Once these requirements are installed, you should create and activate a new
@@ -191,7 +191,7 @@ using the aptly-named `createsuperuser` command:
(.venv)$ ./manage.py createsuperuser
Once this is done, it's beneficial to load some real emails into the system.
-This can be done manually, however it's generally much easier to download an
+This can be done manually, however it's generally much easier to download
an archive from a Mailman instance and load these using the `parsearchive.py`
tool. You can do this like so:
diff --git a/docs/upgrading.md b/docs/upgrading.md
index 453ae94..11434ba 100644
@@ -4,7 +4,7 @@
when upgrading an existing, production installation of Patchwork. If you are
interested in the specific changes between each release, please refer to the
[`UPGRADING` document][gh-upgrading] instead. If this is your first time
-installing Patchwork. please refer to the
+installing Patchwork, please refer to the
[installation guide][doc-installation] instead.
## Before You Start
@@ -13,7 +13,7 @@ Before doing anything, always **backup your data**. This generally means
backing up your database, but it might also be a good idea to backup your
environment in case you encounter issues during the upgrade process.
-While Patchwork won't explicity prevent it, it's generally wise to avoid
+While Patchwork won't explicitly prevent it, it's generally wise to avoid
upgrades spanning multiple releases in one go. An iterative upgrade approach
will provide an easier, if slower, upgrade process.
@@ -124,10 +124,10 @@ latest version of Patchwork, deleting the provided migrations, applying any
patches you may have and regenerating the migrations seems like the best
-**NOTE**: To prevent the latter case above from occuring, we'd ask that you
+**NOTE**: To prevent the latter case above from occurring, we'd ask that you
submit any patches you may have to the upstream Patchwork so that the wider
community can benefit from this new functionality. Please see
-[the contributing document][doc-contributing] for more informtion on this
+[the contributing document][doc-contributing] for more information on this
More information about the Patchwork