Mercurial > kallithea

annotate docs/index.rst @ 633:fcf599cd3404 beta

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move changes for git implementation
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 24 Oct 2010 22:27:28 +0200
parents 60a4aabf6aa6
children afd98d1f817e 674ecf21de85
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
1 .. _index:
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
2
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
3 Welcome to RhodeCode (RhodiumCode) documentation!
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
4 =================================================
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
5
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
6 ``RhodeCode`` (formerly hg-app) is Pylons based repository management and
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
7 serving for mercurial_. It's similar to github or bitbucket, but it's suppose to run
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
8 as standalone app, it's open source and focuses more on restricted access to repositories
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
9 There's no default free access to RhodeCode You have to create an account in order
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
10 to use the application. It's powered by vcs_ library that we created to handle
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
11 many various version control systems.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
12
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
13 RhodeCode uses `Semantic Versioning <http://semver.org/>`_
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
14
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
15
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
16 RhodeCode demo
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
17 --------------
571
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
18
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
19 http://hg.python-works.com
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
20
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
21 The default access is
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
22
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
23 - username: demo
39d9aca6e266 added demo link to docs
Marcin Kuzminski <marcin@python-works.com>
parents: 568
diff changeset
24 - password: demo
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
25
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
26 Source code
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
27 -----------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
28
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
29 Source code is along with issue tracker is available at
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
30 http://bitbucket.org/marcinkuzminski/rhodecode
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
31
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
32 Also a source codes can be obtained from demo rhodecode instance
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
33 http://hg.python-works.com/rhodecode/summary
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
34
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
35 Features
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
36 --------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
37
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
38 - Has it's own middleware to handle mercurial_ protocol request. Each request
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
39 can be logged and authenticated. Runs on threads unlikely to hgweb You can
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
40 make multiple pulls/pushes simultaneous. Supports http/https
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
41 - Full permissions and authentication per project private/read/write/admin.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
42 One account for web interface and mercurial_ push/pull/clone.
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
43 - Mako templates let's you customize look and feel of application.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
44 - Beautiful diffs, annotations and source codes all colored by pygments.
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
45 - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
46 - Admin interface with user/permission management. User activity journal logs
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
47 pulls, pushes, forks,registrations. Possible to disable built in hooks
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
48 - Server side forks, it's possible to fork a project and hack it free without
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
49 breaking the main.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
50 - Full text search on source codes, search on file names. All powered by whoosh
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
51 and build in indexing daemons
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
52 (no external search servers required all in one application)
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
53 - Rss / atom feeds, gravatar support, download sources as zip/tarballs
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
54 - Async tasks for speed and performance using celery_ (works without them too)
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
55 - Backup scripts can do backup of whole app and send it over scp to desired
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
56 location
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
57 - Setup project descriptions and info inside built in db for easy, non
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
58 file-system operations
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
59 - Added cache with invalidation on push/repo management for high performance and
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
60 always up to date data.
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
61 - Based on pylons 1.0 / sqlalchemy 0.6 / sqlite
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
62
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
63
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
64 .. figure:: images/screenshot1_main_page.png
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
65 :align: left
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
66
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
67 Main page of RhodeCode
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
68
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
69 .. figure:: images/screenshot2_summary_page.png
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
70 :align: left
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
71
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
72 Summary page
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
73
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
74
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
75 Incoming
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
76 --------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
77
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
78 - code review (probably based on hg-review)
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
79 - full git_ support, with push/pull server
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
80 - commit based build in wiki system
624
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
81 - clone points and cloning from remote repositories into rhodecode
60a4aabf6aa6 small docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 585
diff changeset
82 (git_ and mercurial_)
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
83 - some cache optimizations
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
84 - other cools stuff that i can figure out (or You can help me figure out)
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
85
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
86 License
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
87 -------
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
88
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
89 ``rhodecode`` is released under GPL_ license.
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
90
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
91
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
92 Documentation
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
93 -------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
94
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
95 **Installation:**
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
96
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
97 .. toctree::
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
98 :maxdepth: 1
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
99
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
100 installation
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
101 setup
585
42a87338035a Version bump.
Marcin Kuzminski <marcin@python-works.com>
parents: 572
diff changeset
102 changelog
0
564e40829f80 initial commit.
Marcin Kuzminski
parents:
diff changeset
103
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
104 Other topics
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
105 ------------
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
106
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
107 * :ref:`genindex`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
108 * :ref:`search`
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
109
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
110 .. _virtualenv: http://pypi.python.org/pypi/virtualenv
568
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
111 .. _python: http://www.python.org/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
112 .. _django: http://www.djangoproject.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
113 .. _mercurial: http://mercurial.selenic.com/
5f481e4e888b updated docs, added sphinx build
Marcin Kuzminski <marcin@python-works.com>
parents: 547
diff changeset
114 .. _subversion: http://subversion.tigris.org/
572
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
115 .. _git: http://git-scm.com/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
116 .. _celery: http://celeryproject.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
117 .. _Sphinx: http://sphinx.pocoo.org/
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
118 .. _GPL: http://www.gnu.org/licenses/gpl.html
a60cd29ba7e2 more docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 571
diff changeset
119 .. _vcs: http://pypi.python.org/pypi/vcs