kallithea Changeset - 22a3fa3c4254

Changeset - 22a3fa3c4254

Parent rev.

Child rev.

[Not reviewed]

default

0 13 0

Mads Kiilerich - 11 years ago 2015-08-20 03:26:18
madski@unity3d.com

docs: cleanup of casing, markup and spacing of headings

Mostly stuff found and fixed by Søren, extracted here to separate things.

Other uses of title casing might be debatable, but here it was just a few
documentation headings that clearly were inconsistent with the majority.

13 files changed with 44 insertions and 41 deletions:

README.rst

docs/api/models.rst

docs/index.rst

docs/installation.rst

docs/installation_iis.rst

docs/installation_win.rst

docs/installation_win_old.rst

docs/overview.rst

docs/setup.rst

docs/usage/email.rst

docs/usage/general.rst

docs/usage/performance.rst

docs/usage/troubleshooting.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -45,8 +45,7 @@ The issue tracker and a repository mirro @@
 https://bitbucket.org/conservancy/kallithea.
 Kallithea Features
 Kallithea features
 ------------------
 - Has its own middleware to handle Mercurial_ and Git_ protocol requests. Each
@@ @@ -162,7 +161,7 @@ database: @@
 - keep the database unconverted (intended for testing and evaluation)
 - convert the database in a one-time step
-Maintaining Interoperability
+Maintaining interoperability
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interoperability with RhodeCode 2.2.X installations is provided so you don't
@@ @@ -181,7 +180,7 @@ via:: @@
 then you will find this location at
 ``$VIRTUAL_ENV/lib/python2.7/site-packages/Kallithea-0.1-py2.7.egg/kallithea``.
-One-time Conversion
+One-time conversion
 ~~~~~~~~~~~~~~~~~~~
 Alternatively, if you would like to convert the database for good, you can use

docs/api/models.rst

➞

Show inline comments

 .. _models:
 ========================
-The :mod:`models` Module
+The :mod:`models` module
 ========================
 .. automodule:: kallithea.model

docs/index.rst

➞

Show inline comments

 .. _index:
 #######################
 Kallithea Documentation
 -----------------------
 #######################
 **Readme**
@@ @@ -32,7 +34,7 @@ Kallithea Documentation @@
    usage/locking
    usage/statistics
-**Administrators Guide**
+**Administrator's guide**
 .. toctree::
    :maxdepth: 1
@@ @@ -43,7 +45,7 @@ Kallithea Documentation @@
    usage/debugging
    usage/troubleshooting
-**Develop**
+**Development**
 .. toctree::
    :maxdepth: 1

docs/installation.rst

➞

Show inline comments

@@ @@ -107,7 +107,7 @@ To install as a regular user in ``~/.loc @@
 You can now proceed to :ref:`setup`.
 Upgrading Kallithea from Python Package Index (PyPI)
------------------------------------------------------
 ----------------------------------------------------
 .. note::
    It is strongly recommended that you **always** perform a database and

docs/installation_iis.rst

➞

Show inline comments

 .. _installation_iis:
 =====================================================================
 Installing Kallithea on Microsoft Internet Information Services (IIS)
 =====================================================================
@@ @@ -24,7 +25,7 @@ The following will assume that your Kall @@
 will be served from the root of its own website. The changes to serve it in its
 own virtual folder will be noted where appropriate.
-Application Pool
+Application pool
 ................
 Make sure that there is a unique application pool for the Kallithea application
@@ @@ -41,7 +42,7 @@ to run on the website and consequently, @@
     as the requirements to Kallithea are enabled by the existing application
     pool.
-ISAPI Handler
+ISAPI handler
 .............
 The ISAPI handler can be generated using::

docs/installation_win.rst

➞

Show inline comments

 .. _installation_win:
+================================================================
 Installation and upgrade on Windows (7/Server 2008 R2 and newer)
 ================================================================
@@ @@ -88,7 +88,7 @@ open a CMD and type:: @@
   SETX PATH "%PATH%;[your-python-path]\Scripts" /M
-Step 5 - Kallithea Folder Structure
+Step 5 - Kallithea folder structure
 -----------------------------------
 Create a Kallithea folder structure.
@@ @@ -151,7 +151,7 @@ The prompt will change into "(Env) C:\\K @@
           normal.
-Step 8 - (Optional) Install git
+Step 8 - Install git (optional)
 -------------------------------
 Mercurial being a python package, it was installed automatically when doing "pip install kallithea".

docs/installation_win_old.rst

➞

Show inline comments

 .. _installation_win_old:
+======================================================================
 Installation and upgrade on Windows (XP/Vista/Server 2003/Server 2008)
 ======================================================================
-First time install
+First-time install
 ::::::::::::::::::
 Target OS: Windows XP SP3 32bit English (Clean installation)
@@ @@ -21,8 +21,8 @@ Target OS: Windows XP SP3 32bit English @@
    - http://blog.victorjabur.com/2011/06/05/compiling-python-2-7-modules-on-windows-32-and-64-using-msvc-2008-express/
    - http://bugs.python.org/issue7511
 Step1 - Install Visual Studio 2008 Express
 ------------------------------------------
 Step 1 - Install Visual Studio 2008 Express
 -------------------------------------------
 Optional: You can also install MinGW, but VS2008 installation is easier.
@@ @@ -57,8 +57,8 @@ choose "Visual C++ 2008 Express" when in @@
    Copy C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\vcvars64.bat to C:\Program Files (x86)\Microsoft Visual Studio 9.0\VC\bin\amd64\vcvarsamd64.bat
 Step2 - Install Python
 ----------------------
 Step 2 - Install Python
 -----------------------
 Install Python 2.x.y (x = 6 or 7) x86 version (32bit). DO NOT USE A 3.x version.
 Download Python 2.x.y from:
@@ @@ -73,8 +73,8 @@ be needed in the next step. In this case @@
 bit: Just download and install the 64bit version of python.
 Step3 - Install Win32py extensions
 ----------------------------------
 Step 3 - Install Win32py extensions
 -----------------------------------
 Download pywin32 from:
 http://sourceforge.net/projects/pywin32/files/
@@ @@ -92,8 +92,8 @@ http://sourceforge.net/projects/pywin32/ @@
      At the time of writing you can find this at:
      http://sourceforge.net/projects/pywin32/files/pywin32/Build%20218/pywin32-218.win-amd64-py2.7.exe/download
 Step4 - Python BIN
 ------------------
 Step 4 - Python BIN
 -------------------
 Add Python BIN folder to the path
@@ @@ -120,8 +120,8 @@ that came preinstalled in Vista/7 and ca @@
   Typically: C:\\Python27
 Step5 - Kallithea folder structure
 ----------------------------------
 Step 5 - Kallithea folder structure
 -----------------------------------
 Create a Kallithea folder structure
@@ @@ -138,7 +138,7 @@ Create the following folder structure:: @@
   C:\Kallithea\Repos
-Step6 - Install virtualenv
+Step 6 - Install virtualenv
 ---------------------------
 Install Virtual Env for Python
@@ @@ -159,8 +159,8 @@ where you downloaded "virtualenv.py", an @@
 to include it)
 Step7 - Install Kallithea
 -------------------------
 Step 7 - Install Kallithea
 --------------------------
 Finally, install Kallithea
@@ @@ -198,8 +198,8 @@ The prompt will change into "(Env) C:\\K @@
 Some warnings will appear, don't worry as they are normal.
 Step8 - Configuring Kallithea
 -----------------------------
 Step 8 - Configuring Kallithea
 ------------------------------
 steps taken from http://packages.python.org/Kallithea/setup.html
@@ @@ -238,8 +238,8 @@ If you make some mistake and the script @@
 it again.
 Step9 - Running Kallithea
 -------------------------
 Step 9 - Running Kallithea
 --------------------------
 In the previous command prompt, being in the C:\\Kallithea\\Bin folder,

docs/overview.rst

➞

Show inline comments

 .. _overview:
 =====================
-Installation Overview
+Installation overview
 =====================
@@ @@ -9,7 +9,7 @@ Some overview and some details that can @@
 installing Kallithea.
-Python Environment
+Python environment
 ------------------
 **Kallithea** is written entirely in Python_ and requires Python version
@@ @@ -38,7 +38,7 @@ environment used for running Kallithea. @@
 We recommend using virtualenv for installing Kallithea.
-Installation Methods
+Installation methods
 --------------------
 Kallithea must be installed on a server. Kallithea is installed in a Python
@@ @@ -71,7 +71,7 @@ installed. @@
   but build the Kallithea package itself locally instead of downloading it.)
-Web Server
+Web server
 ----------
 Kallithea is (primarily) a WSGI_ application that must be run from a web

docs/setup.rst

➞

Show inline comments

@@ @@ -440,7 +440,8 @@ reverse-proxy setup with basic auth:: @@
    forge the authentication header and could effectively become authenticated
    using any account of their liking.
 Integration with Issue trackers
 Integration with issue trackers
 -------------------------------
 Kallithea provides a simple integration with issue trackers. It's possible

docs/usage/email.rst

➞

Show inline comments

@@ @@ -63,6 +63,7 @@ you could set up a local forwarding SMTP @@
 References
 ----------
 - `Error Middleware (Pylons documentation) <http://pylons-webframework.readthedocs.org/en/latest/debugging.html#error-middleware>`_
 - `ErrorHandler (Pylons modules documentation) <http://pylons-webframework.readthedocs.org/en/latest/modules/middleware.html#pylons.middleware.ErrorHandler>`_

docs/usage/general.rst

➞

Show inline comments

@@ @@ -161,7 +161,7 @@ into repositories, e.g., defining a ``re @@
 about a manager of each repository.  There's no limit for adding custom fields.
 Newly created fields are accessible via the API.
-Meta-Tagging
+Meta tagging
 ~~~~~~~~~~~~
 In the `Visual` tab, option `Stylify recognised meta tags` will cause Kallithea

docs/usage/performance.rst

➞

Show inline comments

 .. _performance:
 ================================
-Optimizing Kallithea Performance
+Optimizing Kallithea performance
 ================================
 When serving a large amount of big repositories, Kallithea can start

docs/usage/troubleshooting.rst

➞

Show inline comments

 .. _troubleshooting:
 ===============
 Troubleshooting
 ===============

0 comments (0 inline, 0 general)