diff docs/installation_win.rst @ 4955:4e6dfdb3fa01

docs: English and consistency corrections
author Michael V. DePalatis <mike@depalatis.net>
date Tue, 31 Mar 2015 22:15:38 +0200
parents 03bbd33bc084
children 22a3fa3c4254
line wrap: on
line diff
--- a/docs/installation_win.rst	Tue Mar 31 16:25:49 2015 +0000
+++ b/docs/installation_win.rst	Tue Mar 31 22:15:38 2015 +0200
@@ -19,14 +19,14 @@
 
 Install Python 2.x.y (x = 6 or 7). Latest version is recommended. If you need another version, they can run side by side.
 
-  DO NOT USE A 3.x version.
+.. warning:: Python 3.x is not supported.
 
 - Download Python 2.x.y from http://www.python.org/download/
 - Choose and click on the version
 - Click on "Windows X86-64 Installer" for x64 or "Windows x86 MSI installer" for Win32.
 - Disable UAC or run the installer with admin privileges. If you chose to disable UAC, do not forget to reboot afterwards.
 
-While writing this Guide, the latest version was v2.7.9.
+While writing this guide, the latest version was v2.7.9.
 Remember the specific major and minor versions installed, because they will
 be needed in the next step. In this case, it is "2.7".
 
@@ -34,18 +34,19 @@
 Step 2 - Python BIN
 -------------------
 
-Add Python BIN folder to the path
-
-You have to add the Python folder to the path, you can do it manually (editing "PATH" environment variable) or using Windows Support Tools that came preinstalled in Vista/7 and later.
+Add Python BIN folder to the path. This can be done manually (editing
+"PATH" environment variable) or by using Windows Support Tools that
+come pre-installed in Windows Vista/7 and later.
 
 Open a CMD and type::
 
   SETX PATH "%PATH%;[your-python-path]" /M
 
-Please substitute [your-python-path] with your Python installation path. Typically: C:\\Python27
+Please substitute [your-python-path] with your Python installation
+path. Typically this is ``C:\\Python27``.
 
 
-Step 3 - Install Win32py extensions
+Step 3 - Install pywin32 extensions
 -----------------------------------
 
 Download pywin32 from:
@@ -53,10 +54,13 @@
 
 - Click on "pywin32" folder
 - Click on the first folder (in this case, Build 219, maybe newer when you try)
-- Choose the file ending with ".amd64-py2.x.exe" (".win32-py2.x.exe" for Win32) -> x being the minor version of Python you installed (in this case, 7).
-  When writing this Guide, the file was:
-  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download (x64)
-  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download (Win32)
+- Choose the file ending with ".amd64-py2.x.exe" (".win32-py2.x.exe"
+  for Win32) where x is the minor version of Python you installed.
+  When writing this guide, the file was:
+  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win-amd64-py2.7.exe/download
+  (x64)
+  http://sourceforge.net/projects/pywin32/files/pywin32/Build%20219/pywin32-219.win32-py2.7.exe/download
+  (Win32)
 
 
 Step 4 - Install pip
@@ -72,11 +76,14 @@
 - Right-click on get-pip.py and choose Saves as...
 - Run "python get-pip.py" in the folder where you downloaded get-pip.py (may require admin access).
 
-(See http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows for explanations or alternatives)
+.. note::
 
-Note that pip.exe will be placed inside your Python installation's Scripts folder, which is likely not on your path.
+   See http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows
+   for details and alternative methods.
 
-Open a CMD and type::
+Note that pip.exe will be placed inside your Python installation's
+Scripts folder, which is likely not on your path. To correct this,
+open a CMD and type::
 
   SETX PATH "%PATH%;[your-python-path]\Scripts" /M
 
@@ -86,7 +93,10 @@
 
 Create a Kallithea folder structure.
 
-This is only an example to install Kallithea. Of course, you can change it. However, this Guide will follow the proposed structure, so please later adapt the paths if you change them. Folders with NO SPACES are recommended. But you can try it if you are brave...
+This is only an example to install Kallithea. Of course, you can
+change it. However, this guide will follow the proposed structure, so
+please later adapt the paths if you change them. Folders without
+spaces are recommended.
 
 Create the following folder structure::
 
@@ -101,10 +111,7 @@
 
 .. note::
    A python virtual environment will allow for isolation between the Python packages of your system and those used for Kallithea.
-   It is strongly recommended to use it to ensure that Kallithea does not change a dependency that another software uses or vice versa.
-   If you are using your server (or VM) only for Kallithea, you can skip this step, at your own risk.
-
-Install Virtual Env for Python
+   It is strongly recommended to use it to ensure that Kallithea does not change a dependency that other software uses or vice versa.
 
 In a command prompt type::
 
@@ -120,7 +127,7 @@
 Step 7 - Install Kallithea
 --------------------------
 
-In order to install Kallithea, you need to be able to run "pip install kallithea". It will use Python pip to install the Kallithea Python package and its dependencies.
+In order to install Kallithea, you need to be able to run "pip install kallithea". It will use pip to install the Kallithea Python package and its dependencies.
 Some Python packages use managed code and need to be compiled.
 This can be done on Linux without any special steps. On Windows, you will need to install Microsoft Visual C++ compiler for Python 2.7.
 
@@ -139,13 +146,14 @@
 
   pip install kallithea
 
-(Long step, please wait until fully complete)
-
-Some warnings will appear. Don't worry, they are normal.
+.. note:: This will take some time. Please wait patiently until it is fully
+          complete. Some warnings will appear. Don't worry, they are
+          normal.
 
 
 Step 8 - (Optional) Install git
 -------------------------------
+
 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".
 
 You need to install git manually if you want Kallithea to be able to host git repositories.
@@ -158,28 +166,35 @@
 
 Steps taken from `<setup.html>`_
 
-You have to use the same command prompt as in Step 7, so if you closed it, reopen it following the same commands (including the "activate" one).
-
-When ready, type::
+You have to use the same command prompt as in Step 7, so if you closed
+it, reopen it following the same commands (including the "activate"
+one). When ready, type::
 
   cd C:\Kallithea\Bin
   paster make-config Kallithea production.ini
 
-Then, you must edit production.ini to fit your needs (IP address, IP port, mail settings, database, etc.) NotePad++ (free) or similar text editors are recommended, as they handle well the EndOfLine character differences between Unix and Windows (http://notepad-plus-plus.org/).
+Then you must edit production.ini to fit your needs (IP address, IP
+port, mail settings, database, etc.). `NotePad++`__ or a similar text
+editor is recommended to properly handle the newline character
+differences between Unix and Windows.
 
-For the sake of simplicity, run it with the default settings. After your edits (if any), in the previous Command Prompt, type::
+__ http://notepad-plus-plus.org/
+
+For the sake of simplicity, run it with the default settings. After your edits (if any) in the previous command prompt, type::
 
   paster setup-db production.ini
 
-(This time a NEW database will be installed. You must follow a different step to later UPGRADE to a newer Kallithea version)
+.. warning:: This time a *new* database will be installed. You must
+             follow a different step to later *upgrade* to a newer
+             Kallithea version)
 
-The script will ask you for confirmation about creating a NEW database, answer yes (y)
+The script will ask you for confirmation about creating a new database, answer yes (y)
 
-The script will ask you for repository path, answer C:\\Kallithea\\Repos (or similar).
+The script will ask you for the repository path, answer C:\\Kallithea\\Repos (or similar).
 
-The script will ask you for admin username and password, answer "admin" + "123456" (or whatever you want)
+The script will ask you for the admin username and password, answer "admin" + "123456" (or whatever you want)
 
-The script will ask you for admin mail, answer "admin@xxxx.com" (or whatever you want)
+The script will ask you for admin mail, answer "admin@xxxx.com" (or whatever you want).
 
 If you make a mistake and the script doesn't end, don't worry: start it again.
 
@@ -201,7 +216,7 @@
 If it does not work the first time, Ctrl-C the CMD process and start it again. Don't forget the "http://" in Internet Explorer.
 
 
-What this Guide does not cover:
+What this guide does not cover:
 
 - Installing Celery
 - Running Kallithea as a Windows Service. You can investigate here:
@@ -226,14 +241,14 @@
 
 Backup your production.ini file now.
 
-Then, run::
+Then run::
 
   paster make-config Kallithea production.ini
 
 Look for changes and update your production.ini accordingly.
 
-Then, update the database::
+Next, update the database::
 
   paster upgrade-db production.ini
 
-Full steps in `<upgrade.html>`_
+More details can be found in `<upgrade.html>`_.