Mercurial > kallithea

changeset 2020:bedd7336908c beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs updates
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 22 Feb 2012 21:20:29 +0200
parents 3a014a84a2db
children a04844d9c85b
files README.rst docs/changelog.rst docs/images/.img docs/images/screenshot1_main_page.png docs/images/screenshot2_summary_page.png docs/images/screenshot3_changelog_page.png docs/screenshots.rst
diffstat 6 files changed, 100 insertions(+), 89 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Wed Feb 22 04:42:58 2012 +0200
+++ b/README.rst	Wed Feb 22 21:20:29 2012 +0200
@@ -1,6 +1,9 @@
-========================
-RhodeCode documentation!
-========================
+=========
+RhodeCode
+=========
+
+About
+-----
 
 ``RhodeCode`` is a fast and powerful management tool for Mercurial_ and GIT_ 
 with a built in push/pull server and full text search and code-review.
@@ -17,6 +20,21 @@
 
 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
 
+Installation
+------------
+Stable releases of RhodeCode are best installed via::
+
+    easy_install rhodecode
+
+Or::
+
+    pip install rhodecode 
+
+Detailed instructions and links may be found on the Installation page.
+
+Please visit http://packages.python.org/RhodeCode/installation.html for
+more details
+
 RhodeCode demo
 --------------
 
@@ -45,11 +63,6 @@
 
 https://github.com/marcinkuzminski/rhodecode
 
-Installation
-------------
-
-Please visit http://packages.python.org/RhodeCode/installation.html
-
 
 RhodeCode Features
 ------------------
@@ -91,9 +104,6 @@
   location 
 - Based on pylons / sqlalchemy / sqlite / whoosh / vcs
 
-
-.. include:: ./docs/screenshots.rst
-    
     
 Incoming / Plans
 ----------------
@@ -113,21 +123,35 @@
 ``RhodeCode`` is released under the GPLv3 license.
 
 
-Mailing group Q&A
------------------
+Getting help
+------------
 
-Join the `Google group <http://groups.google.com/group/rhodecode>`_
+Listed bellow are various support resources that should help.
 
-Open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
+.. note::
+   
+   Please try to read the documentation before posting any issues
+ 
+- Join the `Google group <http://groups.google.com/group/rhodecode>`_ and ask
+  any questions.
 
-Join #rhodecode on FreeNode (irc.freenode.net)
-or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
+- 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
+
 
 Online documentation
 --------------------
 
 Online documentation for the current version of RhodeCode is available at
-http://packages.python.org/RhodeCode/.
+ - http://packages.python.org/RhodeCode/
+ - http://rhodecode.readthedocs.org/en/latest/index.html
+
 You may also build the documentation for yourself - go into ``docs/`` and run::
 
    make html
--- a/docs/changelog.rst	Wed Feb 22 04:42:58 2012 +0200
+++ b/docs/changelog.rst	Wed Feb 22 21:20:29 2012 +0200
@@ -5,13 +5,13 @@
 
 
 1.3.0 (**XXXX-XX-XX**)
-======================
+----------------------
 
 :status: in-progress
 :branch: beta
 
 news
-----
+++++
 
 - code review, inspired by github code-comments 
 - #215 rst and markdown README files support
@@ -45,7 +45,7 @@
   
     
 fixes
------
++++++
 
 - rewrote dbsession management for atomic operations, and better error handling
 - fixed sorting of repo tables
@@ -64,13 +64,13 @@
 - #355 RhodeCode doesn't store encrypted LDAP passwords
 
 1.2.5 (**2012-01-28**)
-======================
+----------------------
 
 news
-----
+++++
 
 fixes
------
++++++
 
 - #340 Celery complains about MySQL server gone away, added session cleanup
   for celery tasks
@@ -83,10 +83,10 @@
   forking on windows impossible 
 
 1.2.4 (**2012-01-19**)
-======================
+----------------------
 
 news
-----
+++++
 
 - RhodeCode is bundled with mercurial series 2.0.X by default, with
   full support to largefiles extension. Enabled by default in new installations
@@ -94,7 +94,7 @@
 - added requires.txt file with requirements
      
 fixes
------
++++++
 
 - fixes db session issues with celery when emailing admins
 - #331 RhodeCode mangles repository names if the a repository group 
@@ -111,10 +111,10 @@
 - #316 fixes issues with web description in hgrc files 
 
 1.2.3 (**2011-11-02**)
-======================
+----------------------
 
 news
-----
+++++
 
 - added option to manage repos group for non admin users
 - added following API methods for get_users, create_user, get_users_groups, 
@@ -126,7 +126,7 @@
   administrator users, and global config email.
      
 fixes
------
++++++
 
 - added option for passing auth method for smtp mailer
 - #276 issue with adding a single user with id>10 to usergroups
@@ -134,15 +134,15 @@
 - #288 fixes managing of repos in a group for non admin user
 
 1.2.2 (**2011-10-17**)
-======================
+----------------------
 
 news
-----
+++++
 
 - #226 repo groups are available by path instead of numerical id
  
 fixes
------
++++++
 
 - #259 Groups with the same name but with different parent group
 - #260 Put repo in group, then move group to another group -> repo becomes unavailable
@@ -157,24 +157,24 @@
 - fixes #219 forking problems on windows
 
 1.2.1 (**2011-10-08**)
-======================
+----------------------
 
 news
-----
+++++
 
 
 fixes
------
++++++
 
 - fixed problems with basic auth and push problems 
 - gui fixes
 - fixed logger
 
 1.2.0 (**2011-10-07**)
-======================
+----------------------
 
 news
-----
+++++
 
 - implemented #47 repository groups
 - implemented #89 Can setup google analytics code from settings menu
@@ -214,7 +214,7 @@
 - Implemented advanced hook management
 
 fixes
------
++++++
 
 - fixed file browser bug, when switching into given form revision the url was 
   not changing
@@ -243,15 +243,15 @@
   heads exceeds 5)
     
 1.1.8 (**2011-04-12**)
-======================
+----------------------
 
 news
-----
+++++
 
 - improved windows support
 
 fixes
------
++++++
 
 - fixed #140 freeze of python dateutil library, since new version is python2.x
   incompatible
@@ -274,40 +274,40 @@
 
 
 1.1.7 (**2011-03-23**)
-======================
+----------------------
 
 news
-----
+++++
 
 fixes
------
++++++
 
 - fixed (again) #136 installation support for FreeBSD
 
 
 1.1.6 (**2011-03-21**)
-======================
+----------------------
 
 news
-----
+++++
 
 fixes
------
++++++
 
 - fixed #136 installation support for FreeBSD
 - RhodeCode will check for python version during installation
 
 1.1.5 (**2011-03-17**)
-======================
+----------------------
 
 news
-----
+++++
 
 - basic windows support, by exchanging pybcrypt into sha256 for windows only
   highly inspired by idea of mantis406
 
 fixes
------
++++++
 
 - fixed sorting by author in main page
 - fixed crashes with diffs on binary files
@@ -319,13 +319,13 @@
 - cleaned out docs, big thanks to Jason Harris
 
 1.1.4 (**2011-02-19**)
-======================
+----------------------
 
 news
-----
+++++
 
 fixes
------
++++++
 
 - fixed formencode import problem on settings page, that caused server crash
   when that page was accessed as first after server start
@@ -333,17 +333,17 @@
 - fixed option to access repository just by entering http://server/<repo_name> 
 
 1.1.3 (**2011-02-16**)
-======================
+----------------------
 
 news
-----
+++++
 
 - implemented #102 allowing the '.' character in username
 - added option to access repository just by entering http://server/<repo_name>
 - celery task ignores result for better performance
 
 fixes
------
++++++
 
 - fixed ehlo command and non auth mail servers on smtp_lib. Thanks to 
   apollo13 and Johan Walles
@@ -359,31 +359,31 @@
 - fixed static files paths links to use of url() method
 
 1.1.2 (**2011-01-12**)
-======================
+----------------------
 
 news
-----
+++++
 
 
 fixes
------
++++++
 
 - fixes #98 protection against float division of percentage stats
 - fixed graph bug
 - forced webhelpers version since it was making troubles during installation 
 
 1.1.1 (**2011-01-06**)
-======================
+----------------------
  
 news
-----
+++++
 
 - added force https option into ini files for easier https usage (no need to
   set server headers with this options)
 - small css updates
 
 fixes
------
++++++
 
 - fixed #96 redirect loop on files view on repositories without changesets
 - fixed #97 unicode string passed into server header in special cases (mod_wsgi)
@@ -392,10 +392,10 @@
 - fixed #92 whoosh indexer is more error proof
 
 1.1.0 (**2010-12-18**)
-======================
+----------------------
 
 news
-----
+++++
 
 - rewrite of internals for vcs >=0.1.10
 - uses mercurial 1.7 with dotencode disabled for maintaining compatibility 
@@ -420,7 +420,7 @@
 - other than sqlite database backends can be used
 
 fixes
------
++++++
 
 - fixes #61 forked repo was showing only after cache expired
 - fixes #76 no confirmation on user deletes
@@ -440,16 +440,16 @@
 
 
 1.0.2 (**2010-11-12**)
-======================
+----------------------
 
 news
-----
+++++
 
 - tested under python2.7
 - bumped sqlalchemy and celery versions
 
 fixes
------
++++++
 
 - fixed #59 missing graph.js
 - fixed repo_size crash when repository had broken symlinks
@@ -457,15 +457,15 @@
 
 
 1.0.1 (**2010-11-10**)
-======================
+----------------------
 
 news
-----
+++++
 
 - small css updated
 
 fixes
------
++++++
 
 - fixed #53 python2.5 incompatible enumerate calls
 - fixed #52 disable mercurial extension for web
@@ -473,7 +473,7 @@
 
 
 1.0.0 (**2010-11-02**)
-======================
+----------------------
 
 - security bugfix simplehg wasn't checking for permissions on commands
   other than pull or push.
@@ -483,7 +483,7 @@
 - permissions cached queries
 
 1.0.0rc4  (**2010-10-12**)
-==========================
+--------------------------
 
 - fixed python2.5 missing simplejson imports (thanks to Jens Bäckman)
 - removed cache_manager settings from sqlalchemy meta
@@ -493,12 +493,12 @@
 
 
 1.0.0rc3 (**2010-10-11**)
-=========================
+-------------------------
 
 - fixed i18n during installation.
 
 1.0.0rc2 (**2010-10-11**)
-=========================
+-------------------------
 
 - Disabled dirsize in file browser, it's causing nasty bug when dir renames 
   occure. After vcs is fixed it'll be put back again.
Binary file docs/images/screenshot1_main_page.png has changed
Binary file docs/images/screenshot2_summary_page.png has changed
Binary file docs/images/screenshot3_changelog_page.png has changed
--- a/docs/screenshots.rst	Wed Feb 22 04:42:58 2012 +0200
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,13 +0,0 @@
-.. _screenshots:
-
-.. figure::  images/screenshot1_main_page.png
-
-   Main page of RhodeCode
-
-.. figure::  images/screenshot2_summary_page.png
-
-   Summary page
-   
-.. figure::  images/screenshot3_changelog_page.png
-
-   Changelog with DAG graph
\ No newline at end of file