##// END OF EJS Templates
docs update
marcink -
r796:47d5781b beta
parent child Browse files
Show More
1 NO CONTENT: new file 100644, binary diff hidden
NO CONTENT: new file 100644, binary diff hidden
@@ -0,0 +1,13 b''
1 .. _screenshots:
2
3 .. figure:: images/screenshot1_main_page.png
4
5 Main page of RhodeCode
6
7 .. figure:: images/screenshot2_summary_page.png
8
9 Summary page
10
11 .. figure:: images/screenshot3_changelog_page.png
12
13 Changelog with DAG graph No newline at end of file
@@ -1,10 +1,12 b''
1
1
2 RhodeCode (RhodiumCode)
2 =================================================
3 =======================
3 Welcome to RhodeCode (RhodiumCode) documentation!
4 =================================================
4
5
5 ``RhodeCode`` (formerly hg-app) is Pylons based Mercurial repository
6 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
6 browser/management with build in push/pull server and full text search. It's
7 browser/management with build in push/pull server and full text search.
7 similar to github or bitbucket, but it's suppose to run as standalone hosted
8 It works on http/https, has build in permission/authentication(+ldap) features
9 It's similar to github or bitbucket, but it's suppose to run as standalone hosted
8 application, it's open source and focuses more on restricted access to
10 application, it's open source and focuses more on restricted access to
9 repositories. It's powered by vcs_ library that we created to handle many
11 repositories. It's powered by vcs_ library that we created to handle many
10 various version control systems.
12 various version control systems.
@@ -30,8 +32,8 b' http://bitbucket.org/marcinkuzminski/rho'
30 Also a source codes can be obtained from demo RhodeCode instance
32 Also a source codes can be obtained from demo RhodeCode instance
31 http://hg.python-works.com/rhodecode/summary
33 http://hg.python-works.com/rhodecode/summary
32
34
33 Instalation
35 Installation
34 -----------
36 ------------
35
37
36 Please visit http://packages.python.org/RhodeCode/installation.html
38 Please visit http://packages.python.org/RhodeCode/installation.html
37
39
@@ -66,18 +68,20 b' Features'
66 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
68 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
67
69
68
70
71 .. include:: ./docs/screenshots.rst
72
73
69 Incoming / Plans
74 Incoming / Plans
70 ----------------
75 ----------------
71
76
72 - code review (probably based on hg-review)
77 - code review (probably based on hg-review)
73 - full git_ support, with push/pull server
78 - full git_ support, with push/pull server (currently in beta tests)
74 - project grouping
79 - project grouping
75 - redmine integration
80 - redmine integration
76 - commit based build in wiki system
81 - commit based build in wiki system
77 - clone points and cloning from remote repositories into rhodecode
82 - clone points and cloning from remote repositories into rhodecode
78 (git_ and mercurial_)
83 (git_ and mercurial_)
79 - more statistics and graph (global annotation + some more statistics)
84 - more statistics and graph (global annotation + some more statistics)
80 - user customized activity dashboards
81 - other cools stuff that i can figure out (or You can help me figure out)
85 - other cools stuff that i can figure out (or You can help me figure out)
82
86
83 License
87 License
@@ -89,11 +93,15 b' License'
89 Mailing group Q&A
93 Mailing group Q&A
90 -----------------
94 -----------------
91
95
92 http://groups.google.com/group/rhodecode
96 join the `Google group <http://groups.google.com/group/rhodecode>`_
93
97
98 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
94
99
95 Documentation
100 join #rhodecode on FreeNode (irc.freenode.net)
96 -------------
101 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
102
103 Online documentation
104 --------------------
97
105
98 Online documentation for current version is available at
106 Online documentation for current version is available at
99 http://packages.python.org/RhodeCode/.
107 http://packages.python.org/RhodeCode/.
@@ -101,13 +109,3 b' Documentation'
101
109
102 make html
110 make html
103
111
104 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
105 .. _python: http://www.python.org/
106 .. _django: http://www.djangoproject.com/
107 .. _mercurial: http://mercurial.selenic.com/
108 .. _subversion: http://subversion.tigris.org/
109 .. _git: http://git-scm.com/
110 .. _celery: http://celeryproject.org/
111 .. _Sphinx: http://sphinx.pocoo.org/
112 .. _GPL: http://www.gnu.org/licenses/gpl.html
113 .. _vcs: http://pypi.python.org/pypi/vcs
1 NO CONTENT: modified file, binary diff hidden
NO CONTENT: modified file, binary diff hidden
@@ -1,110 +1,6 b''
1 .. _index:
1 .. _index:
2
2
3 =================================================
3 .. include:: ./../README.rst
4 Welcome to RhodeCode (RhodiumCode) documentation!
5 =================================================
6
7 ``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository
8 browser/management with build in push/pull server and full text search.
9 It works on http/https, has build in permission/authentication(+ldap) features
10 It's similar to github or bitbucket, but it's suppose to run as standalone hosted
11 application, it's open source and focuses more on restricted access to
12 repositories. It's powered by vcs_ library that we created to handle many
13 various version control systems.
14
15 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
16
17 RhodeCode demo
18 --------------
19
20 http://hg.python-works.com
21
22 The default access is
23
24 - username: demo
25 - password: demo
26
27 Source code
28 -----------
29
30 Source code is along with issue tracker is available at
31 http://bitbucket.org/marcinkuzminski/rhodecode
32
33 Also a source codes can be obtained from demo RhodeCode instance
34 http://hg.python-works.com/rhodecode/summary
35
36 Features
37 --------
38
39 - Has it's own middleware to handle mercurial_ and git_ protocol request.
40 Each request can be logged and authenticated. Runs on threads unlikely to
41 hgweb You can make multiple pulls/pushes simultaneous. Supports http/https
42 both on git_ and mercurial_
43 - Full permissions and authentication per project private/read/write/admin.
44 One account for web interface and mercurial_ push/pull/clone.
45 - Mako templates let's you customize look and feel of application.
46 - Beautiful diffs, annotations and source codes all colored by pygments.
47 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
48 - Admin interface with user/permission management. User activity journal logs
49 pulls, pushes, forks,registrations. Possible to disable built in hooks
50 - Server side forks, it's possible to fork a project and hack it free without
51 breaking the main.
52 - Full text search on source codes, search on file names. All powered by whoosh
53 and build in indexing daemons
54 (no external search servers required all in one application)
55 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
56 - Async tasks for speed and performance using celery_ (works without them too)
57 - Backup scripts can do backup of whole app and send it over scp to desired
58 location
59 - Setup project descriptions and info inside built in db for easy, non
60 file-system operations
61 - Added cache with invalidation on push/repo management for high performance and
62 always up to date data.
63 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
64
65
66 .. figure:: images/screenshot1_main_page.png
67
68 Main page of RhodeCode
69
70 .. figure:: images/screenshot2_summary_page.png
71
72 Summary page
73
74 .. figure:: images/screenshot3_changelog_page.png
75
76 Changelog with DAG graph
77
78
79 Incoming / Plans
80 ----------------
81
82 - code review (probably based on hg-review)
83 - full git_ support, with push/pull server
84 - project grouping
85 - redmine integration
86 - commit based build in wiki system
87 - clone points and cloning from remote repositories into rhodecode
88 (git_ and mercurial_)
89 - more statistics and graph (global annotation + some more statistics)
90 - user customized activity dashboards
91 - other cools stuff that i can figure out (or You can help me figure out)
92
93 License
94 -------
95
96 ``rhodecode`` is released under GPL_ license.
97
98
99 Mailing group Q&A
100 -----------------
101
102 join the `Google group <http://groups.google.com/group/rhodecode>`_
103
104 open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_
105
106 join #rhodecode on FreeNode (irc.freenode.net)
107 or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.
108
4
109 Documentation
5 Documentation
110 -------------
6 -------------
General Comments 0
You need to be logged in to leave comments. Login now