From 8a7d037a58f0f2bceca5b96c75bc33c77af90b15 Mon Sep 17 00:00:00 2001
From: Magnus Hagander <magnus@hagander.net>
Date: Thu, 5 Mar 2009 20:17:08 +0100
Subject: [PATCH] Add initial help page.

---
 gitadmin/adm/templates/help.html | 104 +++++++++++++++++++++++++++++++
 gitadmin/adm/urls.py             |   1 +
 gitadmin/adm/views.py            |   2 +
 3 files changed, 107 insertions(+)
 create mode 100644 gitadmin/adm/templates/help.html

diff --git a/gitadmin/adm/templates/help.html b/gitadmin/adm/templates/help.html
new file mode 100644
index 0000000..4332c0d
--- /dev/null
+++ b/gitadmin/adm/templates/help.html
@@ -0,0 +1,104 @@
+{%extends "base.html"%}
+{%block content%}
+<h1>git.postgresql.org</h1>
+
+<h2>Introduction</h2>
+<p>
+The <a href="/">git.postgresql.org</a> service is a code hosting service
+for PostgreSQL code repositories. The only thing hosted are code repositories
+using the <i>git</i> SCM. If you are looking for a more complete project
+hosting including mailing lists and bug trackers, look at
+<a href="http://pgfoundry.org">pgfoundry.org</a>.
+</p>
+<p>
+Obviously, if your project is not PostgreSQL related, this is not the place
+to go looking.
+</p>
+
+<h2>Features</h2>
+<p>
+For read access to all repositories, both <i>git</i> and <i>http</i> access
+is provided. There is also a <i>gitweb</i> browser available. These features
+can be selectively enabled or disabled on a per-repository basis.
+</p>
+<p>
+Each repository also has <i>ssh</i> access. As a repository owner, you can
+also grant other people permissions so that they can also push changes to
+the repository.
+</p>
+
+<h2>Instructions</h2>
+<p>
+Note that all modifications to the system are <i>asynchronous</i>. This means
+that it may take up to 15 minutes after you make a modification before it
+appears in the system.
+</p>
+
+<h3>Community account</h3>
+<p>
+The first step to access the service is to make sure you have a
+<a href="http://wwwmaster.postgresql.org/community/profile">postgresql.org
+community account</a>.
+</p>
+<p>
+Since all access to the git repositories other than anonymous cloning is
+done over the SSH protocol, you need to upload your SSH key to your community
+account at the link above. Note that it can take up to 15 minutes for this
+key to propagate to the git system.
+</p>
+
+<h3>Getting access to an existing repository</h3>
+<p>
+To get access to an existing repository, contact the owner of the repository,
+and he/she can grant you permissions.
+</p>
+
+<h3>Requesting a new repository</h3>
+<p>
+To request a new repository, log in to the <a href="/adm/">admin interface</a>.
+Input the name of your requested repository, and click the <i>Request
+new repository</i> button. Note that the repository name should be a short
+and simple name for your repository using letters and numbers only.
+</p>
+<p>
+Once you have clicked this button you will reach the page to configure the
+repository. Fill in the description (mandatory) and any other fields you
+want.
+</p>
+<p>
+If you enter the URL of another <i>git repository</i> in the field for
+<i>initial clone</i>, this repository will be cloned into the new repository.
+You can also enter the name (not URL) of a local git repository for this. For
+example, enter <i>postgresql</i> to get a clone of the latest available version
+of the core PostgreSQL repository. Note that this will only create an initial
+clone - you will need to manually merge and push any updates after the initial
+clone.
+</p>
+<p>
+Once your repository has been requested, it needs to be approved by one of the
+administrators before you will be able to use it. You can see the status of
+your repository from the main administration page.
+</p>
+
+<h3>Granting permissions</h3>
+<p>
+You can grant permissions to other users on your repository. Input the user
+id of the user in the empty field for users, select the desired permissions
+and click save. The userid is the community login name of the user.
+</p>
+<p>
+To change the permissions of a user, just change the permissions value in
+the dropdown and click Save.
+</p>
+<p>
+Finally, to remove the permissions for a user, mark the checkbox under
+<i>Delete</i> and click Save.
+</p>
+<p>
+If anonymous and/or web access is provided, there is no point in granting
+<i>read</i> permissions, since anybody who wants can clone the repository
+from the anonymous URL instead.
+</p>
+
+{%endblock%}
+
diff --git a/gitadmin/adm/urls.py b/gitadmin/adm/urls.py
index 945bcd8..1ec1ee1 100644
--- a/gitadmin/adm/urls.py
+++ b/gitadmin/adm/urls.py
@@ -6,6 +6,7 @@ urlpatterns = patterns('',
     (r'^repo/(\d+)/$', 'gitadmin.adm.views.editrepo'),
     (r'^repo/(\d+)/delete/$', 'gitadmin.adm.views.deleterepo'),
     (r'^new/$', 'gitadmin.adm.views.newrepo'),
+    (r'^help/$', 'gitadmin.adm.views.help'),
 
 # Log in/out
     (r'^login/$', login),
diff --git a/gitadmin/adm/views.py b/gitadmin/adm/views.py
index d93685b..2d2ac0e 100644
--- a/gitadmin/adm/views.py
+++ b/gitadmin/adm/views.py
@@ -48,6 +48,8 @@ def index(request):
 			'repos': repos,
 		},context_instance=RequestContext(request))
 
+def help(request):
+	return render_to_response('help.html')
 
 @login_required
 @transaction.commit_on_success
-- 
2.39.5