changeset 2601:aa90719e8520 beta

Added troubleshooting section to docs
author Marcin Kuzminski <marcin@python-works.com>
date Sat, 14 Jul 2012 13:03:34 +0200
parents 1b9d6b0a92b3
children 17083006a33d
files README.rst docs/conf.py docs/index.rst docs/setup.rst docs/usage/troubleshooting.rst
diffstat 5 files changed, 78 insertions(+), 40 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Sat Jul 14 12:56:36 2012 +0200
+++ b/README.rst	Sat Jul 14 13:03:34 2012 +0200
@@ -131,7 +131,8 @@
 
 .. 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.
--- a/docs/conf.py	Sat Jul 14 12:56:36 2012 +0200
+++ b/docs/conf.py	Sat Jul 14 13:03:34 2012 +0200
@@ -54,8 +54,8 @@
 # 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__
 
--- a/docs/index.rst	Sat Jul 14 12:56:36 2012 +0200
+++ b/docs/index.rst	Sat Jul 14 13:03:34 2012 +0200
@@ -25,6 +25,7 @@
    usage/statistics
    usage/backup
    usage/debugging
+   usage/troubleshooting
 
 **Develop**
 
--- a/docs/setup.rst	Sat Jul 14 12:56:36 2012 +0200
+++ b/docs/setup.rst	Sat Jul 14 13:03:34 2012 +0200
@@ -687,43 +687,9 @@
 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/
@@ -734,4 +700,4 @@
 .. _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
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/usage/troubleshooting.rst	Sat Jul 14 13:03:34 2012 +0200
@@ -0,0 +1,70 @@
+.. _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