- Further corrections.

README.rst

@@ -1,126 +1,131 b''
 
 =================================================
 Welcome to RhodeCode (RhodiumCode) documentation!
 =================================================
 
-``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 
-browser/management tool with build in push/pull server and full text search.
-It works on http/https, has build in permission/authentication system with 
-ability to auth via LDAP. It's similar in some parts to github or bitbucket, 
-but it's suppose to run as standalone hosted application, it's open source 
-and donation ware and focuses more on providing customized, self administered 
-interface for Mercurial(and soon GIT) repositories. It's powered by vcs_ 
-library that me and Lukasz Balcerzak created to handle many various version 
+``RhodeCode`` (formerly hg-app) is a Pylons framework based Mercurial repository 
+browser/management tool with a built in push/pull server and full text search.
+It works on http/https and has a built in permission/authentication system with 
+the ability to authenticate via LDAP.
+
+RhodeCode is similar in some respects to github or bitbucket, 
+however RhodeCode can be run as standalone hosted application on your own server.  It is open source 
+and donation ware and focuses more on providing a customized, self administered 
+interface for Mercurial(and soon GIT) repositories. RhodeCode is powered by a vcs_ 
+library that Lukasz Balcerzak and I created to handle multiple different version 
 control systems.
 
 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
 
 RhodeCode demo
 --------------
 
 http://hg.python-works.com
 
-The default access is anonymous but You can login to administrative account
-using those credentials
+The default access is anonymous but you can login to an administrative account
+using the following credentials:
 
 - username: demo
 - password: demo
 
 Source code
 -----------
 
-The most up to date sources can be obtained from my own RhodeCode instance
+The latest source for RhodeCode can be obtained from my own RhodeCode instance
 https://rhodecode.org 
 
 Rarely updated source code and issue tracker is available at bitbcuket
 http://bitbucket.org/marcinkuzminski/rhodecode
 
 Installation
 ------------
 
- Please visit http://packages.python.org/RhodeCode/installation.html
+Please visit http://packages.python.org/RhodeCode/installation.html
 
 
-Features
---------
+RhodeCode Features
+------------------
 
-- Has it's own middleware to handle mercurial_ protocol request. 
-  Each request can be logged and authenticated. Runs on threads unlikely to 
-  hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https 
+- Has it's own middleware to handle mercurial_ protocol requests. 
+  Each request can be logged and authenticated.
+- Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https 
   and LDAP
 - Full permissions (private/read/write/admin) and authentication per project. 
   One account for web interface and mercurial_ push/pull/clone operations.
-- Mako templates let's you customize look and feel of application.
-- Beautiful diffs, annotations and source codes all colored by pygments.
+- Mako templates let's you customize the look and feel of the application.
+- Beautiful diffs, annotations and source code browsing all colored by pygments.
 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
 - Admin interface with user/permission management. Admin activity journal, logs
   pulls, pushes, forks, registrations and other actions made by all users.
-- Server side forks, it's possible to fork a project and hack it free without
+- Server side forks. It is possible to fork a project and modify it freely without
   breaking the main repository.
-- Full text search powered by Whoosh on source codes, and file names.
+- Full text search powered by Whoosh on the source files, and file names.
   Build in indexing daemons, with optional incremental index build
   (no external search servers required all in one application)
 - Setup project descriptions and info inside built in db for easy, non 
   file-system operations
 - Intelligent cache with invalidation after push or project change, provides high 
-  performance and always up to date data.    
+  performance and always up to date data.
 - Rss / atom feeds, gravatar support, download sources as zip/tar/gz
 - Async tasks for speed and performance using celery_ (works without them too)  
 - Backup scripts can do backup of whole app and send it over scp to desired 
   location 
 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
 
 
 .. include:: ./docs/screenshots.rst
     
     
 Incoming / Plans
 ----------------
 
-- project grouping
+- Project grouping
 - User groups/teams
-- ssh based authentication with server side key management
-- code review (probably based on hg-review)
-- full git_ support, with push/pull server (currently in beta tests)
-- redmine integration
-- public accessible activity feeds
-- commit based build in wiki system
-- clone points and cloning from remote repositories into RhodeCode
-- more statistics and graph (global annotation + some more statistics)
-- other cools stuff that i can figure out (or You can help me figure out)
+- SSH based authentication with server side key management
+- Code review (probably based on hg-review)
+- Full git_ support, with push/pull server (currently in beta tests)
+- Redmine integration
+- Public accessible activity feeds
+- Commit based built in wiki system
+- Clone points and cloning from remote repositories into RhodeCode
+- More statistics and graph (global annotation + some more statistics)
+- Other advancements as development continues (or you can of course make additions and or requests)
 
 License
 -------
 
-``RhodeCode`` is released under GPL_ license.
+``RhodeCode`` is released under the GPL_ license.
 
 
 Mailing group Q&A
 -----------------
 
-join the `Google group <http://groups.google.com/group/rhodecode>`_
+Join the `Google group <http://groups.google.com/group/rhodecode>`_
 
-open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
+Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
 
-join #rhodecode on FreeNode (irc.freenode.net)
+Join #rhodecode on FreeNode (irc.freenode.net)
 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
 
 Online documentation
 --------------------
 
- Online documentation for current version is available at
- http://packages.python.org/RhodeCode/.
- You may also build documentation for yourself - go into ``docs/`` and run::
+Online documentation for the current version of RhodeCode is available at
+http://packages.python.org/RhodeCode/.
+You may also build the documentation for yourself - go into ``docs/`` and run::
 
    make html
 
+(You need to have sphinx installed to build the documentation. If you don't
+have sphinx installed you can install it via the command: ``easy_install sphinx``)
+ 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
 .. _Sphinx: http://sphinx.pocoo.org/
 .. _GPL: http://www.gnu.org/licenses/gpl.html
 .. _vcs: http://pypi.python.org/pypi/vcs
  No newline at end of file

docs/contributing.rst

@@ -1,17 +1,19 b''
 .. _contributing:
 
-Contributing in RhodeCode
+Contributing to RhodeCode
 =========================
 
-If You would like to contribute to RhodeCode, please contact me, any help is
-greatly appreciated.
+If you would like to contribute to RhodeCode, please contact me, any help is
+greatly appreciated!
 
-Preferable method Would be to fork RhodeCode repository from bitbucket
-https://bitbucket.org/marcinkuzminski/rhodecode and then open a pull request.
-This way it's easier for me to merge.
+Could I request that you make your source contributions by first forking the
+RhodeCode repository on bitbucket
+https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to
+your forked repository. Finally, when you are finished making a change, please
+send me a pull request.
 
-To run RhodeCode in a development version You always need to install tip
-version of RhodeCode and VCS library.
+To run RhodeCode in a development version you always need to install the tip
+version of RhodeCode and the VCS library.
 
-
-Thank You.
+| Thank you for any contributions!
+|  Marcin
  No newline at end of file

docs/enable_git.rst

@@ -1,21 +1,22 b''
 .. _enable_git:
 
 Enabling GIT support (beta)
 ===========================
 
 
-Git support in RhodeCode 1.1 was disabled due to some instability issues, but
-If You would like to test it fell free to re-enable it. To enable GIT just
-uncomment git line in rhodecode/__init__.py file
+Git support in RhodeCode 1.1 was disabled due to current instability issues. However,
+if you would like to test git support please feel free to re-enable it. To re-enable GIT support just
+uncomment the git line in the file rhodecode/__init__.py
 
 .. code-block:: python
  
    BACKENDS = {
        'hg': 'Mercurial repository',
        #'git': 'Git repository',
    }
 
 .. note::
-   Please note that it's not fully stable and it might crash (that's why it 
-   was disabled), so be careful about enabling git support. Don't use it in 
-   production !
  No newline at end of file
+   Please note that the git support provided by RhodeCode is not yet fully
+   stable and RhodeCode might crash while using git repositories. (That is why
+   it is currently disabled.) Thus be careful about enabling git support, and
+   certainly don't use it in a production setting!
  No newline at end of file

docs/installation.rst

@@ -1,112 +1,104 b''
 .. _installation:
 
 Installation
 ============
 
-``RhodeCode`` is written entirely in Python, but in order to use it's full
-potential there are some third-party requirements. When RhodeCode is used 
-together with celery You have to install some kind of message broker,
+``RhodeCode`` is written entirely in Python. In order to gain maximum performance
+there are some third-party you must install. When RhodeCode is used 
+together with celery you have to install some kind of message broker,
 recommended one is rabbitmq_ to make the async tasks work.
 
-Of course RhodeCode works in sync mode also, then You don't have to install
-any third party apps. Celery_ will give You large speed improvement when using
-many big repositories. If You plan to use it for 7 or 10 small repositories, it
-will work just fine without celery running.
+Of course RhodeCode works in sync mode also and then you do not have to install
+any third party applications. However, using Celery_ will give you a large speed improvement when using
+many big repositories. If you plan to use RhodeCode for say 7 to 10 small repositories, RhodeCode
+will perform perfectly well without celery running.
    
-After You decide to Run it with celery make sure You run celeryd using paster
+If you make the decision to run RhodeCode with celery make sure you run celeryd using paster
 and message broker together with the application.   
 
-Install from Cheese Shop
+Installing RhodeCode from Cheese Shop
 ------------------------
-Rhodecode requires python 2.x greater than version 2.5
+Rhodecode requires python version 2.5 or higher.
 
-Easiest way to install ``rhodecode`` is to run::
+The easiest way to install ``rhodecode`` is to run::
 
     easy_install rhodecode
 
 Or::
 
     pip install rhodecode
 
-If you prefer to install manually simply grab latest release from
-http://pypi.python.org/pypi/rhodecode, decompress archive and run::
+If you prefer to install RhodeCode manually simply grab latest release from
+http://pypi.python.org/pypi/rhodecode, decompress the archive and run::
 
     python setup.py install
 
 
 Step by step installation example
 ---------------------------------
 
 
-- Assuming You have installed virtualenv_ create one using. 
-
-::
+- Assuming you have installed virtualenv_ create a new virtual environment using virtualenv:: 
 
     virtualenv --no-site-packages /var/www/rhodecode-venv
 
 
 .. note:: Using ``--no-site-packages`` when generating your
-   virtualenv is *very important*. This flag provides the necessary
+   virtualenv is **very important**. This flag provides the necessary
    isolation for running the set of packages required by
    RhodeCode.  If you do not specify ``--no-site-packages``,
    it's possible that RhodeCode will not install properly into
    the virtualenv, or, even if it does, may not run properly,
    depending on the packages you've already got installed into your
    Python's "main" site-packages dir.
 
 
 - this will install new virtualenv_ into `/var/www/rhodecode-venv`. 
-- Activate the virtualenv_ by running 
-
-::
+- Activate the virtualenv_ by running::
 
     source /var/www/rhodecode-venv/bin/activate
 
-.. note:: If you're on UNIX, *do not* use ``sudo`` to run the
+.. note:: If you're using UNIX, *do not* use ``sudo`` to run the
    ``virtualenv`` script.  It's perfectly acceptable (and desirable)
    to create a virtualenv as a normal user.
      
-- Make a folder for rhodecode somewhere on the filesystem for example 
-
-::
+- Make a folder for rhodecode somewhere on the filesystem for example::
 
     mkdir /var/www/rhodecode
   
     
-- Run this command to install rhodecode
-
-::
+- Run this command to install rhodecode::
 
     easy_install rhodecode 
 
-- this will install rhodecode together with pylons
-  and all other required python libraries
+- This will install rhodecode together with pylons and all other required python
+  libraries
 
 Requirements for Celery (optional)
 ----------------------------------
 
 .. note::
    Installing message broker and using celery is optional, RhodeCode will
-   work without them perfectly fine.
+   work perfectly fine without them.
 
 
 **Message Broker** 
 
 - preferred is `RabbitMq <http://www.rabbitmq.com/>`_
-- possible other is `Redis <http://code.google.com/p/redis/>`_
+- A possible alternative is `Redis <http://code.google.com/p/redis/>`_
 
-For installation instructions You can visit: 
-http://ask.github.com/celery/getting-started/index.html
-It's very nice tutorial how to start celery_ with rabbitmq_
+For installation instructions you can visit: 
+http://ask.github.com/celery/getting-started/index.html.
+This is a very nice tutorial on how to start using celery_ with rabbitmq_
 
 
 You can now proceed to :ref:`setup`
 -----------------------------------
 
 
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv  
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
  No newline at end of file

docs/setup.rst

@@ -1,380 +1,380 b''
 .. _setup:
 
 Setup
 =====
 
 
 Setting up RhodeCode
 --------------------------
 
 First, you will need to create a RhodeCode configuration file. Run the following
 command to do this::
  
  paster make-config RhodeCode production.ini
 
 - This will create the file `production.ini` in the current directory. This
   configuration file contains the various settings for RhodeCode, e.g proxy port,
   email settings, usage of static files, cache, celery settings and logging.
 
 
 Next, you need to create the databases used by RhodeCode. I recommend that you
 use sqlite (default) or postgresql. If you choose a database other than the
 default ensure you properly adjust the db url in your production.ini
 configuration file to use this other database. Create the databases by running
 the following command::
 
  paster setup-app production.ini
 
 This will prompt you for a "root" path. This "root" path is the location where
 RhodeCode will store all of its repositories on the current machine. After
 entering this "root" path ``setup-app`` will also prompt you for a username and password
 for the initial admin account which ``setup-app`` sets up for you.
 
 - The ``setup-app`` command will create all of the needed tables and an admin
-  account. When choosing a root path You can either use a new empty location, or a
+  account. When choosing a root path you can either use a new empty location, or a
   location which already contains existing repositories. If you choose a location
   which contains existing repositories RhodeCode will simply add all of the
   repositories at the chosen location to it's database. (Note: make sure you
   specify the correct path to the root).
 - Note: the given path for mercurial_ repositories **must** be write accessible
   for the application. It's very important since the RhodeCode web interface will
   work without write access, but when trying to do a push it will eventually fail
   with permission denied errors unless it has write access.
 
 You are now ready to use RhodeCode, to run it simply execute::
  
  paster serve production.ini
  
 - This command runs the RhodeCode server. The web app should be available at the 
   127.0.0.1:5000. This ip and port is configurable via the production.ini 
   file created in previous step
 - Use the admin account you created above when running ``setup-app`` to login to the web app.
 - The default permissions on each repository is read, and the owner is admin. 
   Remember to update these if needed.
-- In the admin panel You can toggle ldap, anonymous, permissions settings. As
+- In the admin panel you can toggle ldap, anonymous, permissions settings. As
   well as edit more advanced options on users and repositories
 
 Try copying your own mercurial repository into the "root" directory you are
 using, then from within the RhodeCode web application choose Admin >
 repositories. Then choose Add New Repository. Add the repository you copied into
 the root. Test that you can browse your repository from within RhodeCode and then
 try cloning your repository from RhodeCode with::
 
   hg clone http://127.0.0.1:5000/<repository name>
 
 where *repository name* is replaced by the name of your repository.
 
 Using RhodeCode with SSH
 ------------------------
 
 RhodeCode currently only hosts repositories using http and https. (The addition of
 ssh hosting is a planned future feature.) However you can easily use ssh in
 parallel with RhodeCode. (Repository access via ssh is a standard "out of
 the box" feature of mercurial_ and you can use this to access any of the
 repositories that RhodeCode is hosting. See PublishingRepositories_)
 
 RhodeCode repository structures are kept in directories with the same name 
 as the project. When using repository groups, each group is a subdirectory.
 This allows you to easily use ssh for accessing repositories.
 
 In order to use ssh you need to make sure that your web-server and the users login
 accounts have the correct permissions set on the appropriate directories. (Note
 that these permissions are independent of any permissions you have set up using
 the RhodeCode web interface.)
 
 If your main directory (the same as set in RhodeCode settings) is for example
 set to **/home/hg** and the repository you are using is named `rhodecode`, then
 to clone via ssh you should run::
 
     hg clone ssh://[e-mail]/home/hg/rhodecode
 
 Using other external tools such as mercurial-server_ or using ssh key based
 authentication is fully supported.
 
 Note: In an advanced setup, in order for your ssh access to use the same
 permissions as set up via the RhodeCode web interface, you can create an
 authentication hook to connect to the rhodecode db and runs check functions for
 permissions against that.
 
 
     
 Setting up Whoosh full text search
 ----------------------------------
 
 Starting from version 1.1 the whoosh index can be build by using the paster
-command ``make-index``. To use ``make-index`` You must specify the configuration
+command ``make-index``. To use ``make-index`` you must specify the configuration
 file that stores the location of the index, and the location of the repositories
 (`--repo-location`).
 
 You may optionally pass the option `-f` to enable a full index rebuild. Without
 the `-f` option, indexing will run always in "incremental" mode.
 
 For an incremental index build use::
 
 	paster make-index production.ini --repo-location=<location for repos> 
 
 For a full index rebuild use::
 
 	paster make-index production.ini -f --repo-location=<location for repos>
 
 - For full text search you can either put crontab entry for
 
 In order to do periodical index builds and keep your index always up to date.
 It's recommended to do a crontab entry for incremental indexing. 
 An example entry might look like this::
  
  /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 
   
 When using incremental mode (the default) whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
 available. The indexing daemon checks for any removed files and removes them
 from index.
 
 If you want to rebuild index from scratch, you can use the `-f` flag as above,
 or in the admin panel you can check `build from scratch` flag.
 
 
 Setting up LDAP support
 -----------------------
 
 RhodeCode starting from version 1.1 supports ldap authentication. In order
 to use LDAP, you have to install the python-ldap_ package. This package is available
 via pypi, so you can install it by running
 
 ::
 
  easy_install python-ldap
  
 ::
 
  pip install python-ldap
 
 .. note::
    python-ldap requires some certain libs on your system, so before installing 
    it check that you have at least `openldap`, and `sasl` libraries.
 
 ldap settings are located in admin->ldap section,
 
 Here's a typical ldap setup::
 
  Enable ldap  = checked                 #controls if ldap access is enabled
  Host         = host.domain.org         #actual ldap server to connect
  Port         = 389 or 689 for ldaps    #ldap server ports
  Enable LDAPS = unchecked               #enable disable ldaps
  Account      = <account>               #access for ldap server(if required)
  Password     = <password>              #password for ldap server(if required)
  Base DN      = uid=%(user)s,CN=users,DC=host,DC=domain,DC=org
  
 
 `Account` and `Password` are optional, and used for two-phase ldap 
 authentication so those are credentials to access your ldap, if it doesn't 
 support anonymous search/user lookups. 
 
 Base DN must have the %(user)s template inside, it's a place holder where your uid
 used to login would go. It allows admins to specify non-standard schema for the
 uid variable.
 
 If all of the data is correctly entered, and `python-ldap` is properly
 installed, then users should be granted access to RhodeCode with ldap accounts.
 When logging in the first time a special ldap account is created inside
 RhodeCode, so you can control the permissions even on ldap users. If such users
 already exist in the RhodeCode database, then the ldap user with the same
 username would be not be able to access RhodeCode.
 
 If you have problems with ldap access and believe you have correctly entered the
 required information then proceed by investigating the RhodeCode logs. Any
 error messages sent from ldap will be saved there.
 
 
 
 Setting Up Celery
 -----------------
 
 Since version 1.1 celery is configured by the rhodecode ini configuration files.
 Simply set use_celery=true in the ini file then add / change the configuration 
 variables inside the ini file.
 
 Remember that the ini files use the format with '.' not with '_' like celery.
 So for example setting `BROKER_HOST` in celery means setting `broker.host` in
 the config file.
 
 In order to start using celery run::
 
  paster celeryd <configfile.ini>
 
 
 .. note::
    Make sure you run this command from the same virtualenv, and with the same user
    that rhodecode runs.
    
 HTTPS support
 -------------
 
 There are two ways to enable https:
 
 - Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will
   recognize this headers and make proper https redirections
 - Alternatively, set `force_https = true` in the ini configuration to force using
   https, no headers are needed than to enable https
 
 
 Nginx virtual host example
 --------------------------
 
 Sample config for nginx using proxy::
 
     server {
        listen          80;
        server_name     hg.myserver.com;
        access_log      /var/log/nginx/rhodecode.access.log;
        error_log       /var/log/nginx/rhodecode.error.log;
        location / {
                root /var/www/rhodecode/rhodecode/public/;
                if (!-f $request_filename){
                    proxy_pass      http://127.0.0.1:5000;
                }
                #this is important if you want to use https !!!
                proxy_set_header X-Url-Scheme $scheme;
                include         /etc/nginx/proxy.conf;  
        }
     }  
   
 Here's the proxy.conf. It's tuned so it will not timeout on long
 pushes or large pushes::
 
     proxy_redirect              off;
     proxy_set_header            Host $host;
     proxy_set_header            X-Host $http_host;
     proxy_set_header            X-Real-IP $remote_addr;
     proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header            Proxy-host $proxy_host;
     client_max_body_size        400m;
     client_body_buffer_size     128k;
     proxy_buffering             off;
     proxy_connect_timeout       3600;
     proxy_send_timeout          3600;
     proxy_read_timeout          3600;
     proxy_buffer_size           16k;
     proxy_buffers               4 16k;
     proxy_busy_buffers_size     64k;
     proxy_temp_file_write_size  64k;
  
 Also, when using root path with nginx you might set the static files to false
 in the production.ini file::
 
     [app:main]
       use = egg:rhodecode
       full_stack = true
       static_files = false
       lang=en
       cache_dir = %(here)s/data
 
 In order to not have the statics served by the application. This improves speed.
 
 
 Apache virtual host example
 ---------------------------
 
 Here is a sample configuration file for apache using proxy::
 
     <VirtualHost *:80>
             ServerName hg.myserver.com
             ServerAlias hg.myserver.com
     
             <Proxy *>
               Order allow,deny
               Allow from all
             </Proxy>
     
             #important !
             #Directive to properly generate url (clone url) for pylons
             ProxyPreserveHost On
     
             #rhodecode instance
             ProxyPass / http://127.0.0.1:5000/
             ProxyPassReverse / http://127.0.0.1:5000/
             
             #to enable https use line below
             #SetEnvIf X-Url-Scheme https HTTPS=1
             
     </VirtualHost> 
 
 
 Additional tutorial
 http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons
 
 
 Apache as subdirectory
 ----------------------
 
 
 Apache subdirectory part::
 
     <Location /rhodecode>
       ProxyPass http://127.0.0.1:59542/rhodecode
       ProxyPassReverse http://127.0.0.1:59542/rhodecode
       SetEnvIf X-Url-Scheme https HTTPS=1
     </Location> 
 
 Besides the regular apache setup you will need to add the following to your .ini file::
 
     filter-with = proxy-prefix
 
 Add the following at the end of the .ini file::
 
     [filter:proxy-prefix]
     use = egg:PasteDeploy#prefix
     prefix = /<someprefix> 
 
 
 Apache's example FCGI config
 ----------------------------
 
 TODO !
 
 Other configuration files
 -------------------------
 
 Some example init.d scripts can be found here, for debian and gentoo:
 
 https://rhodeocode.org/rhodecode/files/tip/init.d
 
 
 Troubleshooting
 ---------------
 
 :Q: **Missing static files?**
 :A: Make sure either to set the `static_files = true` in the .ini file or
    double check the root path for your http setup. It should point to 
    for example:
    /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public
 
 |
 :Q: **Can't install celery/rabbitmq**
 :A: Don't worry RhodeCode works without them too. No extra setup is required.
 
 |
 :Q: **Long lasting push timeouts?**
 :A: Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts
    are caused by https server and not RhodeCode.
 
 |
 :Q: **Large pushes timeouts?**
 :A: Make sure you set a proper max_body_size for the http server.
 
 |
 :Q: **Apache doesn't pass basicAuth on pull/push?**
 :A: Make sure you added `WSGIPassAuthorization true`.
 
 For further questions search the `Issues tracker`_, or post a message in the `google group rhodecode`_
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
 .. _python-ldap: http://www.python-ldap.org/
 .. _mercurial-server: http://www.lshift.net/mercurial-server.html
 .. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories
 .. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues
 .. _google group rhodecode: http://groups.google.com/group/rhodecode
  No newline at end of file

docs/statistics.rst

@@ -1,32 +1,33 b''
 .. _statistics:
 
 
 Statistics
 ==========
 
-RhodeCode statistics system is heavy on resources, so in order to keep a 
-balance between the usability and performance statistics are cached inside db
-and are gathered incrementally, this is how RhodeCode does this:
+The RhodeCode statistics system makes heavy demands of the server resources, so
+in order to keep a balance between usability and performance, the statistics are
+cached inside db and are gathered incrementally, this is how RhodeCode does
+this:
 
 With Celery disabled
 ++++++++++++++++++++
 
-- on each first visit on summary page a set of 250 commits are parsed and
-  updates statistics cache
-- this happens on each single visit of statistics page until all commits are
-  fetched. Statistics are kept cached until some more commits are added to
-  repository, in such case RhodeCode will fetch only the ones added and will
-  update it's cache.
+- On each first visit to the summary page a set of 250 commits are parsed and
+  updates statistics cache.
+- This happens on each single visit to the statistics page until all commits are
+  fetched. Statistics are kept cached until additional commits are added to the
+  repository. In such a case RhodeCode will only fetch the new commits when
+  updating it's cache.
 
 
 With Celery enabled
 +++++++++++++++++++
 
-- on first visit on summary page RhodeCode will create task that will execute
-  on celery workers, that will gather all stats until all commits are parsed,
-  each task will parse 250 commits, and run next task to parse next 250 
-  commits, until all are parsed.
+- On the first visit to the summary page RhodeCode will create tasks that will
+  execute on celery workers. This task will gather all of the stats until all
+  commits are parsed, each task will parse 250 commits, and run the next task to
+  parse next 250 commits, until all of the commits are parsed.
 
 .. note::
-   In any time You can disable statistics on each repository in repository edit
-   form in admin panel, just uncheck the statistics checkbox.
  No newline at end of file
+   At any time you can disable statistics on each repository via the repository
+   edit form in the admin panel. To do this just uncheck the statistics checkbox.
  No newline at end of file

docs/upgrade.rst

@@ -1,56 +1,51 b''
 .. _upgrade:
 
 Upgrade
 =======
 
-Upgrade from Cheese Shop
+Upgrading from Cheese Shop
 ------------------------
 
-Easiest way to upgrade ``rhodecode`` is to run::
+.. note::
+   Firstly, it is recommended that you **always** perform a database backup before doing an upgrade.
+
+The easiest way to upgrade ``rhodecode`` is to run::
 
  easy_install -U rhodecode
 
 Or::
 
  pip install --upgrade rhodecode
 
 
-Then make sure You run from the installation directory
-
-::
+Then make sure you run the following command from the installation directory::
  
  paster make-config RhodeCode production.ini
  
-This will display any changes made from new version of RhodeCode To your
-current config. And tries to do an automerge. It's always better to do a backup
-of config file and recheck the content after merge.
+This will display any changes made by the new version of RhodeCode to your
+current configuration. It will try to perform an automerge. It's always better
+to make a backup of your configuration file before hand and recheck the content after the automerge.
 
 .. note::
    The next steps only apply to upgrading from non bugfix releases eg. from
    any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will 
-   not have any database schema changes or whoosh library updates
+   not have any database schema changes or whoosh library updates.
 
-It's also good to rebuild the whoosh index since after upgrading the whoosh 
-version there could be introduced incompatible index changes.
+It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh 
+version could introduce some incompatible index changes.
 
 
-The last step is to upgrade the database. To do this simply run
-
-::
+The final step is to upgrade the database. To do this simply run::
 
     paster upgrade-db production.ini
  
-This will upgrade schema, as well as update some default on the database,
-always recheck the settings of the application, if there are no new options
+This will upgrade the schema and update some of the defaults in the database,
+and will always recheck the settings of the application, if there are no new options
 that need to be set.
 
-.. note::
-   Always perform a database backup before doing upgrade.
-
-
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv  
 .. _python: http://www.python.org/
 .. _mercurial: http://mercurial.selenic.com/
 .. _celery: http://celeryproject.org/
 .. _rabbitmq: http://www.rabbitmq.com/
  No newline at end of file