Mercurial > kallithea

changeset 796:47d5781bfe8a beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs update
author Marcin Kuzminski <marcin@python-works.com>
date Mon, 29 Nov 2010 23:35:30 +0100
parents 3025b0f9475e
children be15cc83361c
files README.rst docs/images/screenshot2_summary_page.png docs/images/screenshot3_changelog_page.png docs/index.rst docs/screenshots.rst
diffstat 5 files changed, 34 insertions(+), 127 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Mon Nov 29 22:54:45 2010 +0100
+++ b/README.rst	Mon Nov 29 23:35:30 2010 +0100
@@ -1,10 +1,12 @@
 
-RhodeCode (RhodiumCode)
-=======================
+=================================================
+Welcome to RhodeCode (RhodiumCode) documentation!
+=================================================
 
-``RhodeCode`` (formerly hg-app) is Pylons based Mercurial repository 
-browser/management with build in push/pull server and full text search. It's 
-similar to github or bitbucket, but it's suppose to run as standalone hosted 
+``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 
+browser/management with build in push/pull server and full text search.
+It works on http/https, has build in permission/authentication(+ldap) features 
+It's similar to github or bitbucket, but it's suppose to run as standalone hosted 
 application, it's open source and focuses more on restricted access to 
 repositories. It's powered by vcs_ library that we created to handle many 
 various version control systems.
@@ -30,8 +32,8 @@
 Also a source codes can be obtained from demo RhodeCode instance
 http://hg.python-works.com/rhodecode/summary
 
-Instalation
------------
+Installation
+------------
 
  Please visit http://packages.python.org/RhodeCode/installation.html
 
@@ -66,18 +68,20 @@
 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
 
 
+.. include:: ./docs/screenshots.rst
+    
+    
 Incoming / Plans
 ----------------
 
 - code review (probably based on hg-review)
-- full git_ support, with push/pull server
+- full git_ support, with push/pull server (currently in beta tests)
 - project grouping
 - redmine integration
 - commit based build in wiki system
 - clone points and cloning from remote repositories into rhodecode 
   (git_ and mercurial_)
 - more statistics and graph (global annotation + some more statistics)
-- user customized activity dashboards
 - other cools stuff that i can figure out (or You can help me figure out)
 
 License
@@ -89,11 +93,15 @@
 Mailing group Q&A
 -----------------
 
-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>`_
 
-Documentation
--------------
+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/.
@@ -101,13 +109,3 @@
 
    make html
 
-.. _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
Binary file docs/images/screenshot2_summary_page.png has changed
Binary file docs/images/screenshot3_changelog_page.png has changed
--- a/docs/index.rst	Mon Nov 29 22:54:45 2010 +0100
+++ b/docs/index.rst	Mon Nov 29 23:35:30 2010 +0100
@@ -1,110 +1,6 @@
 .. _index:
 
-=================================================
-Welcome to RhodeCode (RhodiumCode) documentation!
-=================================================
-
-``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 
-browser/management with build in push/pull server and full text search.
-It works on http/https, has build in permission/authentication(+ldap) features 
-It's similar to github or bitbucket, but it's suppose to run as standalone hosted 
-application, it's open source and focuses more on restricted access to 
-repositories. It's powered by vcs_ library that we created to handle many 
-various version control systems.
-
-RhodeCode uses `Semantic Versioning <http://semver.org/>`_
-
-RhodeCode demo
---------------
-
-http://hg.python-works.com
-
-The default access is
-
-- username: demo
-- password: demo
-
-Source code
------------
-
-Source code is along with issue tracker is available at
-http://bitbucket.org/marcinkuzminski/rhodecode
-
-Also a source codes can be obtained from demo RhodeCode instance
-http://hg.python-works.com/rhodecode/summary
-
-Features
---------
-
-- Has it's own middleware to handle mercurial_ and git_ 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
-  both on git_ and mercurial_
-- Full permissions and authentication per project private/read/write/admin. 
-  One account for web interface and mercurial_ push/pull/clone.
-- Mako templates let's you customize look and feel of application.
-- Beautiful diffs, annotations and source codes all colored by pygments.
-- Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
-- Admin interface with user/permission management. User activity journal logs
-  pulls, pushes, forks,registrations. Possible to disable built in hooks
-- Server side forks, it's possible to fork a project and hack it free without
-  breaking the main.   
-- Full text search on source codes, search on file names. All powered by whoosh
-  and build in indexing daemons
-  (no external search servers required all in one application)
-- Rss / atom feeds, gravatar support, download sources as zip/tarballs  
-- 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
-- Setup project descriptions and info inside built in db for easy, non 
-  file-system operations
-- Added cache with invalidation on push/repo management for high performance and
-  always up to date data. 
-- Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
-
-
-.. 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
-    
-    
-Incoming / Plans
-----------------
-
-- code review (probably based on hg-review)
-- full git_ support, with push/pull server
-- project grouping
-- redmine integration
-- commit based build in wiki system
-- clone points and cloning from remote repositories into rhodecode 
-  (git_ and mercurial_)
-- more statistics and graph (global annotation + some more statistics)
-- user customized activity dashboards
-- other cools stuff that i can figure out (or You can help me figure out)
-
-License
--------
-
-``rhodecode`` is released under GPL_ license.
-
-
-Mailing group Q&A
------------------
-
-join the `Google group <http://groups.google.com/group/rhodecode>`_
-
-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.
+.. include:: ./../README.rst
 
 Documentation
 -------------
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/screenshots.rst	Mon Nov 29 23:35:30 2010 +0100
@@ -0,0 +1,13 @@
+.. _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