Commit 65ef914a authored by Abhilash Raj's avatar Abhilash Raj

Merge branch 'patch-1' into 'master'

Spelling/typos/grammar in pre-installation-guide.rst

See merge request !21
parents c153b9d7 f498f41c
Pipeline #34243278 failed with stages
......@@ -59,7 +59,7 @@ Mailman 2.1 to Mailman 3.1 is not very easy, though it can be done with some
scripting. We are working on it and it should be working soon, we don't have an
exact timeline on it though.
Archives however can be imported into Hyperkitty easily, however URLs to
Archives however can be imported into Hyperkitty easily, but URLs to
attachments are going to break because the URL paths are different in
Hyperkitty. Although, You might be able to retain your HTML archives from
Mailman 2.1 and continue archiving newer emails in Hyperkitty.
......@@ -83,7 +83,7 @@ trying to deploy Mailman 3:
* ``pip`` is the `Python's official package manager`_ and can be used to
download and install libraries and packages from PyPI_ a.k.a Python
CheeseShop. On most Linux based distributions, you can install it form the
CheeseShop. On most Linux based distributions, you can install it from the
distro's package manager. Here are the instructions for ``apt`` & ``yum`` (or
``dnf``) based systems::
......@@ -93,7 +93,7 @@ trying to deploy Mailman 3:
$ sudo yum install python3-pip
If you have any other Linux distro, please check their documentation on how to
If you have any other Linux distro, please check its documentation on how to
install. After that, you can use it to install python packages using the
command like below::
......@@ -108,8 +108,8 @@ trying to deploy Mailman 3:
* Django_ is the Python web framework that Postorius & Hyperkitty are based
on. It allows you to run several different web "apps" under a single
"project". People often write their web applications as reusable Django "apps"
which can then be plugged into any running Django "project". Django "project"
is also sometimes called as a Django "installation".
which can then be plugged into any running Django "project". A Django "project"
is also sometimes called a Django "installation".
A typical Django project has a structure of something like this::
......@@ -126,14 +126,14 @@ trying to deploy Mailman 3:
Here is a brief overview of these files:
* ``urls.py``: This is how Django routes request. If you want to install a new
Django "app", you have to add it's ``base_url`` to this file.
* ``urls.py``: This is how Django routes requests. If you want to install a new
Django "app", you have to add its ``base_url`` to this file.
* ``settings.py`` : This is Django's configuration file. It is the home for
all the different configuration options that are required.
* ``manage.py`` : This is a generally a helper script used to perform
administrative tasks from command line on a Django project. You should never
* ``manage.py`` : This is a generic helper script used to perform
administrative tasks from the command line on a Django project. You should never
edit this file after creating a project.
* ``wsgi.py`` : This is the WSGI_ or Web Server Gateway Interface application
......@@ -144,7 +144,7 @@ trying to deploy Mailman 3:
.. _about-wsgi:
* **wsgi** or the Web Server Gateway Interface is the protocol by which Python
web applications talk to the web servers. While Django comes with a in-built
web applications talk to web servers. Django comes with a built-in
web server, which you can invoke by using the following command::
$ python manage.py runserver
......@@ -154,11 +154,11 @@ trying to deploy Mailman 3:
--help`` for more instructions.
To deploy any Python based web application, you need an intermediate WSGI
server which mediates the interaction between Python and Web Server. There are
server which mediates the interaction between Python and a web server. There are
several of them out there but we recommend using uwsgi_. Uwsgi has several
advantages over others including the ability to configure completely using
environment variables which helps in container based deployments. Also, Nginx
and Apache web servers have plugins built-in for Uwsgi which makes the it even
advantages over others including the ability to configure it entirely using
environment variables, which helps in container based deployments. Also, Nginx
and Apache web servers have plugins built-in for Uwsgi which makes the it an even
more compelling candidate.
However, you are not tied to using Uwsgi and are free to choose any other WSGI
......@@ -166,7 +166,7 @@ trying to deploy Mailman 3:
.. _django-static-files:
* When running Django using the inbuilt development server, Django serves it's
* When running Django using the built-in development web server, Django serves its
static files which makes it easy for the developers. However, in production
environment, it is advised to serve the static files separately.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment