kallithea Changeset - aa90719e8520

Changeset - aa90719e8520

Parent rev.

Child rev.

[Not reviewed]

beta

0 4 1

Marcin Kuzminski - 14 years ago 2012-07-14 13:03:34
marcin@python-works.com

Added troubleshooting section to docs

5 files changed with 78 insertions and 40 deletions:

README.rst

docs/conf.py

docs/index.rst

docs/setup.rst

docs/usage/troubleshooting.rst

0 comments (0 inline, 0 general)

README.rst

➞

Show inline comments

@@ @@ -122,25 +122,26 @@ License @@
 -------
 ``RhodeCode`` is released under the GPLv3 license.
 Getting help
 ------------
 Listed bellow are various support resources that should help.
 .. note::
    Please try to read the documentation before posting any issues
    Please try to read the documentation before posting any issues, especially
    the **troubleshooting section**
 - Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
   any questions.
 - Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
 - Join #rhodecode on FreeNode (irc.freenode.net)
   or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
 - You can also follow me on twitter **@marcinkuzminski** where i often post some
   news about RhodeCode

docs/conf.py

➞

Show inline comments

@@ @@ -45,26 +45,26 @@ master_doc = 'index' @@
 # General information about the project.
 project = u'RhodeCode'
 copyright = u'%s, Marcin Kuzminski' % (datetime.datetime.now().year)
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
+#
 # The short X.Y version.
 root = os.path.dirname(os.path.dirname(__file__))
 sys.path.append(root)
 from rhodecode import get_version, __version__
 version = get_version()
 from rhodecode import __version__
 version = __version__
 # The full version, including alpha/beta/rc tags.
 release = __version__
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #language = None
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 #today = ''
 # Else, today_fmt is used as the format for a strftime call.
 #today_fmt = '%B %d, %Y'

docs/index.rst

➞

Show inline comments

@@ @@ -16,24 +16,25 @@ Users Guide @@
 **Usage**
 .. toctree::
    :maxdepth: 1
    usage/general
    usage/git_support
    usage/performance
    usage/statistics
    usage/backup
    usage/debugging
    usage/troubleshooting
 **Develop**
 .. toctree::
    :maxdepth: 1
    contributing
    changelog
 **API**
 .. toctree::

docs/setup.rst

➞

Show inline comments

@@ @@ -678,60 +678,26 @@ Example wsgi dispatch script:: @@
     fileConfig('/home/web/rhodecode/production.ini')
     application = loadapp('config:/home/web/rhodecode/production.ini')
 Note: when using mod_wsgi you'll need to install the same version of
 Mercurial that's inside RhodeCode's virtualenv also on the system's Python
 environment.
 Other configuration files
 -------------------------
 Some example init.d scripts can be found here, for debian and gentoo:
 https://rhodecode.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.
 Some example init.d scripts can be found in init.d directory::
+|
 :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`_
   https://secure.rhodecode.org/rhodecode/files/beta/init.d
 .. _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
 .. _google group rhodecode: http://groups.google.com/group/rhodecode
@@ \ No newline at end of file @@

docs/usage/troubleshooting.rst

➞

Show inline comments

@@ new file 100644 @@
 .. _troubleshooting:
 ===============
 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.
     Try out great celery docs for further help.
+|
 :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. Very often
     Apache, Nginx or other http servers kill the connection due to to large
     body.
+|
 :Q: **Apache doesn't pass basicAuth on pull/push?**
 :A: Make sure you added `WSGIPassAuthorization true`.
+|
 :Q: **Git fails on push/pull?**
 :A: Make sure you're using an wsgi http server that can handle chunked encoding
     such as `waitress` or `gunicorn`
+|
 :Q: **How i use hooks in RhodeCode?**
 :A: It's easy if they are python hooks just use advanced link in hooks section
     in Admin panel, that works only for Mercurial. If you want to use githooks,
     just install proper one in repository eg. create file in
     `/gitrepo/hooks/pre-receive`. You can also use RhodeCode-extensions to
     connect to callback hooks, for both Git and Mercurial.
+|
 :Q: **RhodeCode is slow for me, how can i make it faster?**
 :A: See the :ref:`performance` section
 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 @@

0 comments (0 inline, 0 general)