# HG changeset patch # User Marcin Kuzminski # Date 2012-09-02 18:53:09 # Node ID 5d12768a0aa191f0262a579a9b8b328273e10b6e # Parent 4bc4e53fd6feedd927e100b8971d6d81c9f90558 docs improvements diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -72,25 +72,26 @@ RhodeCode Features Each request can be logged and authenticated. - Runs on threads unlike hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https and LDAP -- Full permissions (private/read/write/admin) and authentication per project. - One account for web interface and mercurial_ push/pull/clone operations. +- Full permissions (private/read/write/admin) for each repository, additional + explicit forking and repository permissions. - Have built in users groups for easier permission management - Repository groups let you group repos and manage them easier. - Users can fork other users repo. RhodeCode have also compare view to see combined changeset for all changeset made within single push. - Build in commit-api let's you add, edit and commit files right from RhodeCode interface using simple editor or upload form for binaries. +- Powerfull pull-request driven review system with inline commenting, and + changeset statuses, notification system. +- Importing SVN repositories from remote locations into RhodeCode. - Mako templates let's you customize the look and feel of the application. - Beautiful diffs, annotations and source code browsing all colored by pygments. - Raw diffs are made in git-diff format, including git_ binary-patches + Raw diffs are made in git-diff format, including GIT_ binary-patches - Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics - Admin interface with user/permission management. Admin activity journal, logs pulls, pushes, forks, registrations and other actions made by all users. - Server side forks. It is possible to fork a project and modify it freely without breaking the main repository. You can even write Your own hooks and install them -- code review with notification system, inline commenting, all parsed using - rst syntax - rst and markdown README support for repositories - Full text search powered by Whoosh on the source files, and file names. Build in indexing daemons, with optional incremental index build @@ -110,8 +111,9 @@ Incoming / Plans ---------------- - Finer granular permissions per branch, repo group or subrepo -- pull requests and web based merges -- per line file history +- Pull requests with web based merges +- Per line file history +- Simple issue tracker - SSH based authentication with server side key management - Commit based built in wiki system - More statistics and graph (global annotation + some more statistics) diff --git a/docs/changelog.rst b/docs/changelog.rst --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -35,8 +35,9 @@ news - File view now displays small gravatars off all authors of given file - Implemented landing revisions. Each repository will get landing_rev attribute that defines 'default' revision/branch for generating readme files -- Implemented #509, RhodeCode enforces SSL for push/pulling if requested. -- Import remote svn repositories to mercurial using hgsubversion +- Implemented #509, RhodeCode enforces SSL for push/pulling if requested at + earliest possible call. +- Import remote svn repositories to mercurial using hgsubversion. - Fixed #508 RhodeCode now has a option to explicitly set forking permissions - RhodeCode can use alternative server for generating avatar icons - implemented repositories locking. Pull locks, push unlocks. Also can be done diff --git a/docs/usage/general.rst b/docs/usage/general.rst --- a/docs/usage/general.rst +++ b/docs/usage/general.rst @@ -62,7 +62,6 @@ the _ syntax can be used anywhere in for changelogs, files and other can be exchanged with _ syntax. - Mailing ------- diff --git a/docs/usage/performance.rst b/docs/usage/performance.rst --- a/docs/usage/performance.rst +++ b/docs/usage/performance.rst @@ -4,6 +4,17 @@ Optimizing RhodeCode Performance ================================ +When serving large amount of big repositories RhodeCode can start +performing slower than expected. Because of demanding nature of handling large +amount of data from version control systems here are some tips how to get +the best performance. + +* RhodeCode will perform better on machines with faster disks (SSD/SAN). It's + more important to have faster disk than faster CPU. + +* Slowness on initial page can be easily fixed by grouping repositories, and/or + increasing cache size (see below) + Follow these few steps to improve performance of RhodeCode system. @@ -18,7 +29,8 @@ 1. Increase cache few hundreds of repositories on main page can sometimes make the system to behave slow when cache expires for all of them. Increasing `expire` option to day (86400) or a week (604800) will improve general response - times for the main page + times for the main page. RhodeCode has an intelligent cache expiration + system and it will expire cache for repositories that had been changed. 2. Switch from sqlite to postgres or mysql @@ -28,7 +40,6 @@ 2. Switch from sqlite to postgres or mys performance increase. 3. Scale RhodeCode horizontally - - running two or more instances on the same server can speed up things a lot - load balance using round robin or ip hash