changeset 1123:9472a0150bf0 beta

docs update
author Marcin Kuzminski <marcin@python-works.com>
date Wed, 09 Mar 2011 20:46:43 +0100
parents 31e82d872631
children c52de8aa10e0
files README.rst docs/changelog.rst docs/contributing.rst docs/index.rst docs/installation.rst docs/setup.rst docs/upgrade.rst docs/usage/api_key_access.rst docs/usage/enable_git.rst docs/usage/general.rst docs/usage/statistics.rst
diffstat 11 files changed, 63 insertions(+), 36 deletions(-) [+]
line wrap: on
line diff
--- a/README.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/README.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -8,7 +8,7 @@
 It works on http/https and has a built in permission/authentication system with 
 the ability to authenticate via LDAP.
 
-RhodeCode is similar in some respects to github or bitbucket, 
+RhodeCode is similar in some respects to github or bitbucket_, 
 however RhodeCode can be run as standalone hosted application on your own server.  
 It is open source and donation ware and focuses more on providing a customized, 
 self administered interface for Mercurial(and soon GIT) repositories. 
@@ -57,7 +57,7 @@
   combined changeset for all changeset made within single push.
 - 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
+  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.
@@ -127,6 +127,7 @@
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
+.. _bitbucket: http://bitbucket.org/
 .. _subversion: http://subversion.tigris.org/
 .. _git: http://git-scm.com/
 .. _celery: http://celeryproject.org/
--- a/docs/changelog.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/changelog.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -16,7 +16,6 @@
 - implemented #91 added nicer looking archive urls with more download options
   like tags, branches
 - implemented #44 into file browsing, and added follow branch option
-- implemented #102 allowing '.' in username
 - implemented #84 downloads can be enabled/disabled for each repository 
 - anonymous repository can be cloned without having to pass default:default
   into clone url
@@ -26,13 +25,16 @@
 - implemented #107 customizable code highlights on code sources
 - implemented #93 customizable changelog on combined revision ranges - 
   equivalent of githubs compare view 
-- implemented #108 extended and more powerfull LDAP configuration
+- implemented #108 extended and more powerful LDAP configuration
 - implemented #56 users groups
 - major code rewrites optimized codes for speed and memory usage
 - raw and diff downloads are now in git format
 - setup command checks for write access to given path
 - fixed many issues with international characters and unicode. It uses utf8
   decode with replace to provide less errors even with non utf8 encoded strings
+- #125 added API KEY access to feeds
+- #109 Repository can be created from external Mercurial link, and manually
+  updated (via pull) from admin panel
 
 fixes
 -----
@@ -46,6 +48,7 @@
 - journal fork fixes
 - removed issue with space inside renamed repository after deletion
 - fixed strange issue on formencode imports
+- fixed #126 Deleting repository on Windows, rename used incompatible chars. 
 
 1.1.4 (**2011-02-19**)
 ======================
--- a/docs/contributing.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/contributing.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -7,13 +7,19 @@
 greatly appreciated!
 
 Could I request that you make your source contributions by first forking the
-RhodeCode repository on bitbucket
+RhodeCode repository on bitbucket_
 https://bitbucket.org/marcinkuzminski/rhodecode and then make your changes to
-your forked repository. Finally, when you are finished making a change, please
-send me a pull request.
+your forked repository. Please post all fixes into **BETA** branch since your 
+fix might be already fixed there and i try to merge all fixes from beta into
+stable, and not the other way. Finally, when you are finished making a change, 
+please send me a pull request.
 
 To run RhodeCode in a development version you always need to install the tip
 version of RhodeCode and the VCS library.
 
 | Thank you for any contributions!
 |  Marcin
+
+
+
+.. _bitbucket: http://bitbucket.org/
--- a/docs/index.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/index.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -23,6 +23,7 @@
    usage/enable_git
    usage/statistics
    usage/backup
+   usage/api_key_access
    
 **Develop**
 
@@ -50,9 +51,10 @@
 .. _python: http://www.python.org/
 .. _django: http://www.djangoproject.com/
 .. _mercurial: http://mercurial.selenic.com/
+.. _bitbucket: http://bitbucket.org/
 .. _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
+.. _vcs: http://pypi.python.org/pypi/vcs
\ No newline at end of file
--- a/docs/installation.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/installation.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -9,12 +9,13 @@
 recommended one is rabbitmq_ to make the async tasks work.
 
 Of course RhodeCode works in sync mode also and then you do not have to install
-any third party applications. However, using Celery_ will give you a large speed improvement when using
-many big repositories. If you plan to use RhodeCode for say 7 to 10 small repositories, RhodeCode
-will perform perfectly well without celery running.
+any third party applications. However, using Celery_ will give you a large 
+speed improvement when using many big repositories. If you plan to use 
+RhodeCode for say 7 to 10 small repositories, RhodeCode will perform perfectly 
+well without celery running.
    
-If you make the decision to run RhodeCode with celery make sure you run celeryd using paster
-and message broker together with the application.   
+If you make the decision to run RhodeCode with celery make sure you run 
+celeryd using paster and message broker together with the application.   
 
 Installing RhodeCode from Cheese Shop
 -------------------------------------
--- a/docs/setup.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/setup.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -10,7 +10,7 @@
 First, you will need to create a RhodeCode configuration file. Run the following
 command to do this::
  
- paster make-config RhodeCode production.ini
+    paster make-config RhodeCode production.ini
 
 - This will create the file `production.ini` in the current directory. This
   configuration file contains the various settings for RhodeCode, e.g proxy port,
@@ -23,7 +23,7 @@
 configuration file to use this other database. Create the databases by running
 the following command::
 
- paster setup-app production.ini
+    paster setup-app production.ini
 
 This will prompt you for a "root" path. This "root" path is the location where
 RhodeCode will store all of its repositories on the current machine. After
@@ -43,7 +43,7 @@
 
 You are now ready to use RhodeCode, to run it simply execute::
  
- paster serve production.ini
+    paster serve production.ini
  
 - This command runs the RhodeCode server. The web app should be available at the 
   127.0.0.1:5000. This ip and port is configurable via the production.ini 
@@ -60,7 +60,7 @@
 the root. Test that you can browse your repository from within RhodeCode and then
 try cloning your repository from RhodeCode with::
 
-  hg clone http://127.0.0.1:5000/<repository name>
+    hg clone http://127.0.0.1:5000/<repository name>
 
 where *repository name* is replaced by the name of your repository.
 
@@ -128,7 +128,7 @@
 It's recommended to do a crontab entry for incremental indexing. 
 An example entry might look like this::
  
- /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 
+    /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 
   
 When using incremental mode (the default) whoosh will check the last
 modification date of each file and add it to be reindexed if a newer file is
@@ -148,11 +148,11 @@
 
 ::
 
- easy_install python-ldap
+    easy_install python-ldap
  
 ::
 
- pip install python-ldap
+    pip install python-ldap
 
 .. note::
    python-ldap requires some certain libs on your system, so before installing 
--- a/docs/upgrade.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/upgrade.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -7,7 +7,8 @@
 --------------------------
 
 .. note::
-   Firstly, it is recommended that you **always** perform a database backup before doing an upgrade.
+   Firstly, it is recommended that you **always** perform a database backup 
+   before doing an upgrade.
 
 The easiest way to upgrade ``rhodecode`` is to run::
 
@@ -24,15 +25,16 @@
  
 This will display any changes made by the new version of RhodeCode to your
 current configuration. It will try to perform an automerge. It's always better
-to make a backup of your configuration file before hand and recheck the content after the automerge.
+to make a backup of your configuration file before hand and recheck the 
+content after the automerge.
 
 .. note::
    The next steps only apply to upgrading from non bugfix releases eg. from
    any minor or major releases. Bugfix releases (eg. 1.1.2->1.1.3) will 
    not have any database schema changes or whoosh library updates.
 
-It is also recommended that you rebuild the whoosh index after upgrading since the new whoosh 
-version could introduce some incompatible index changes.
+It is also recommended that you rebuild the whoosh index after upgrading since 
+the new whoosh version could introduce some incompatible index changes.
 
 
 The final step is to upgrade the database. To do this simply run::
@@ -40,8 +42,8 @@
     paster upgrade-db production.ini
  
 This will upgrade the schema and update some of the defaults in the database,
-and will always recheck the settings of the application, if there are no new options
-that need to be set.
+and will always recheck the settings of the application, if there are no new 
+options that need to be set.
 
 
 .. _virtualenv: http://pypi.python.org/pypi/virtualenv  
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/usage/api_key_access.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -0,0 +1,11 @@
+.. _api_key_access:
+
+Access to RhodeCode via API KEY
+===============================
+
+Starting from version 1.2 rss/atom feeds and journal feeds
+can be accessed via **api_key**. This unique key is automatically generated for
+each user in RhodeCode application. Using this key it is possible to access 
+feeds without having to log in. When user changes his password a new API KEY
+is generated for him automatically. You can check your API KEY in account 
+settings page. 
\ No newline at end of file
--- a/docs/usage/enable_git.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/usage/enable_git.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -4,9 +4,10 @@
 ===========================
 
 
-Git support in RhodeCode 1.1 was disabled due to current instability issues. However,
-if you would like to test git support please feel free to re-enable it. To re-enable GIT support just
-uncomment the git line in the file rhodecode/__init__.py
+Git support in RhodeCode 1.1 was disabled due to current instability issues. 
+However,if you would like to test git support please feel free to re-enable it. 
+To re-enable GIT support just uncomment the git line in the 
+file **rhodecode/__init__.py**
 
 .. code-block:: python
  
--- a/docs/usage/general.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/usage/general.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -5,7 +5,7 @@
 
 
 Repository deleting
-+++++++++++++++++++
+-------------------
 
 Currently when admin/owner deletes a repository, RhodeCode does not physically
 delete a repository from filesystem, it renames it in a special way so it's
@@ -15,7 +15,7 @@
 from the repository name, and internal repository storage (.hg/.git)
 
 Follow current branch in file view
-++++++++++++++++++++++++++++++++++
+----------------------------------
 
 In file view when this checkbox is checked the << and >> arrows will jump
 to changesets within the same branch currently viewing. So for example
@@ -24,7 +24,7 @@
 
 
 Compare view from changelog
-+++++++++++++++++++++++++++
+---------------------------
 
 Checkboxes in compare view allow users to view combined compare view. You can
 only show the range between the first and last checkbox (no cherry pick).
@@ -38,7 +38,7 @@
 
 
 Mailing
-+++++++
+-------
 
 When administrator will fill up the mailing settings in .ini files
 RhodeCode will send mails on user registration, or when RhodeCode errors occur
@@ -46,7 +46,7 @@
 
 
 Trending source files
-+++++++++++++++++++++
+---------------------
 
 Trending source files are calculated based on pre defined dict of known
 types and extensions. If You miss some extension or Would like to scan some
--- a/docs/usage/statistics.rst	Wed Mar 09 20:46:20 2011 +0100
+++ b/docs/usage/statistics.rst	Wed Mar 09 20:46:43 2011 +0100
@@ -10,7 +10,7 @@
 this:
 
 With Celery disabled
-++++++++++++++++++++
+--------------------
 
 - On each first visit to the summary page a set of 250 commits are parsed and
   updates statistics cache.
@@ -21,7 +21,7 @@
 
 
 With Celery enabled
-+++++++++++++++++++
+-------------------
 
 - On the first visit to the summary page RhodeCode will create tasks that will
   execute on celery workers. This task will gather all of the stats until all