Skip to content

Commit 5655f19

Browse files
jasdeepgilljelmer
authored andcommitted
Various text improvements to documentation.
* Minor text improvements to faq.rst * Fixed minor mistake to faq.rst * Minor grammar fixes to troubleshooting.rst * Minor grammar improvements to quickstart.rst * Minor text changes to install.rst * Improved text in multiple-sites.rst * Misspelled word * Minor text changes
1 parent 7eed747 commit 5655f19

File tree

7 files changed

+21
-20
lines changed

7 files changed

+21
-20
lines changed

docs/docs/extras/deployment.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Deployment
44
Isso ships with a built-in web server, which is useful for the initial setup
55
and may be used in production for low-traffic sites (up to 20 requests per
66
second). Running a "real" WSGI server supports nice things such as UNIX domain
7-
sockets, daemonization and solid HTTP handler while being more stable, secure
7+
sockets, daemonization and solid HTTP handler. WSGI servers are more stable, secure
88
and web-scale than the built-in web server.
99

1010
* gevent_, coroutine-based network library
@@ -188,7 +188,7 @@ The Apache configuration will then be similar to the following:
188188
</VirtualHost>
189189
190190
You will need to adjust the user and group according to your Apache installation and
191-
security policy. Be also aware that the directory containing the comments database must
191+
security policy. Be aware that the directory containing the comments database must
192192
be writable by the user or group running the WSGI daemon process: having a writable
193193
database only is not enough, since SQLite will need to create a lock file in the same
194194
directory.

docs/docs/install.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ libraries, but most likely not all required by Isso (or in an up-to-date
2222
version – looking at you, Debian!).
2323

2424
That's why most Python developers use the `Python Package Index`_ to get their
25-
dependencies. But the most important rule: never install *anything* from PyPi
25+
dependencies. The most important rule to follow is to never install *anything* from PyPi
2626
as root. Not because of malicious software, but because you *will* break your
2727
system.
2828
``easy_install`` is one tool to mess up your system. Another package manager is
2929
``pip``. If you ever searched for an issue with Python/pip and Stackoverflow is
30-
suggesting your ``easy_install pip`` or ``pip install --upgrade pip`` (as root
30+
suggesting you ``easy_install pip`` or ``pip install --upgrade pip`` (as root
3131
of course!), you are doing it wrong. `Why you should not use Python's
3232
easy_install carelessly on Debian`_ is worth the read.
3333

@@ -228,7 +228,7 @@ don't use FastCGi or uWSGI:
228228

229229
If you're writing your own init script, you can utilize ``start-stop-daemon``
230230
to run Isso in the background (Isso runs in the foreground usually). Below you
231-
find a very basic SysVinit script which you can use for inspiration:
231+
will find a very basic SysVinit script which you can use for inspiration:
232232

233233
.. code-block:: sh
234234

docs/docs/man/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ What's Isso?
66

77
Isso is a lightweight commenting server similar to Disqus. It allows anonymous
88
comments, maintains identity and is simple to administrate. It uses JavaScript
9-
and cross-origin ressource sharing for easy integration into static websites.
9+
and cross-origin resource sharing for easy integration into static websites.
1010

1111
No, I meant "Isso"
1212
------------------

docs/docs/quickstart.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Quickstart
22
==========
33

44
Assuming you have successfully :doc:`installed <install>` Isso, here's
5-
a quickstart quide that covers the most common setup. Sections covered:
5+
a quickstart guide that covers the most common setup. Sections covered:
66

77
.. contents::
88
:local:
@@ -18,7 +18,8 @@ sane defaults.
1818
.. code-block:: ini
1919
2020
[general]
21-
; database location, check permissions, automatically created if not exists
21+
; database location, check permissions, automatically created if it
22+
does not exist
2223
dbpath = /var/lib/isso/comments.db
2324
; your website or blog (not the location of Isso!)
2425
host = http://example.tld/
@@ -62,7 +63,7 @@ Migration
6263

6364
Isso provides a tool for importing comments from Disqus_ or WordPress_.
6465
You can also import comments from any other comment system, but this topic is more
65-
complex and covered in :doc:`advanced migration <extras/advanced-migration>`.
66+
complex and is covered in :doc:`advanced migration <extras/advanced-migration>`.
6667

6768
To export your comments from Disqus, log into Disqus, go to your website, click
6869
on *Discussions* and select the *Export* tab. You'll receive an email with your
@@ -140,7 +141,7 @@ a comment to see if the setup works. If not, see :doc:`troubleshooting`.
140141
Going Further
141142
-------------
142143

143-
There are several server and client configuration options uncovered in this
144+
There are several server and client configuration options not covered in this
144145
quickstart, check out :doc:`configuration/server` and
145146
:doc:`configuration/client` for more information. For further website
146147
integration, see :doc:`extras/advanced-integration`.

docs/docs/setup/multiple-sites.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Multiple Sites
55
--------------
66

77
Isso is designed to serve comments for a single website and therefore stores
8-
comments for a relative URL to support HTTP, HTTPS and even domain transfers
9-
without manual intervention. But you can chain Isso to support multiple
8+
comments for a relative URL. This is done to support HTTP, HTTPS and even domain transfers
9+
without manual intervention. You can chain Isso to support multiple
1010
websites on different domains.
1111

1212
The following example uses `gunicorn <http://gunicorn.org/>`_ as WSGI server (

docs/docs/troubleshooting.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Troubleshooting
44
For uberspace users
55
-------------------
66
Some uberspace users experienced problems with isso and they solved their
7-
issue by adding `DirectoryIndex disabled` as the first line in the `.htaccess`
7+
issues by adding `DirectoryIndex disabled` as the first line in the `.htaccess`
88
file for the domain the isso server is running on.
99

1010
pkg_ressources.DistributionNotFound
@@ -29,9 +29,9 @@ encoding either in :envvar:`LANG`, :envvar:`LANGUAGE`, :envvar:`LC_ALL` or
2929
3030
$ env LANG=C.UTF-8 isso [-h] [--version] ...
3131
32-
If none of the mentioned variables is set, the interaction with Isso will
32+
If none of the mentioned variables are set, the interaction with Isso will
3333
likely fail (unable to print non-ascii characters to stdout/err, unable to
34-
parse configuration file with non-ascii characters and to forth).
34+
parse configuration file with non-ascii characters and so forth).
3535

3636
The web console shows 404 Not Found responses
3737
---------------------------------------------

docs/faq.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Frequently asked question
44
Why SQLite3?
55
------------
66

7-
Although partially answered on the index page, here a more complete answer: If
7+
Although partially answered on the index page, here is a more complete answer: If
88
you manage massive amounts of comments, Isso is a really bad choice. Isso is
9-
designed to be simple and easy to setup, not optimizied for high-traffic
9+
designed to be simple and easy to setup, it is not optimized for high-traffic
1010
websites (use a `dedicated Disqus`_ instance then).
1111

12-
comments are not big data
12+
Comments are not big data.
1313

14-
For example, 209 threads and 778 comments in total only need 620K (kilobyte)
15-
memory. Excellent use case for SQLite.
14+
For example, if you have 209 threads and 778 comments in total this only needs 620 kilobytes
15+
of memory. This is an excellent use case for SQLite.
1616

1717
.. _dedicated Disqus:

0 commit comments

Comments
 (0)