*major* doc revamp

people will NOT read documentation, especially the bloody install
documentation.  I'm about ready to throw in the towel and declare
gitolite unsupported, take-it-or-leave-it.

But I'm making one last attempt to refocus the install doc to better
suit the "I know I'm very smart and I dont have to read docs so it's
clearly your fault that I am not able to install gitolite" crowd.

As a bonus, though, I ended up making proper, hyper-linked, TOCs for
most of the docs, and moved a whole bunch of stuff around.  Also finally
got some of the ssh stuff over from my git-notes repo because it really
belongs here.
This commit is contained in:
Sitaram Chamarty 2010-05-21 17:53:05 +05:30
parent 025de395dc
commit 196b41e0fd
16 changed files with 930 additions and 557 deletions

View file

@ -11,16 +11,18 @@ There may be other such **WARNING** sections below. **Read all of them**.
In this document:
* background
* setting it up
* anatomy of a command
* example uses and sample commands in contrib
* fork
* rmrepo
* (bonus) restricted admin
* <a href="#A1">background</a>
* <a href="#A2">setting it up</a>
* <a href="#A3">anatomy of a command</a>
* <a href="#A4">example uses and sample commands in contrib</a>
* <a href="#A5">fork</a>
* <a href="#A6">rmrepo</a>
* <a href="#A7">(bonus) restricted admin</a>
----
<a name="A1"></a>
### background
Gitolite was named to be short for "gitosis-lite". Someone now wants to turn
@ -59,6 +61,8 @@ What we want now is more than that, as you'll see in the examples below. And
I'm sure if you think of more uses you'll send them to me as "contrib"
entries, right?
<a name="A2"></a>
### setting it up
This can only be setup by someone who has shell access to the server. Edit
@ -77,6 +81,8 @@ to inadvertently *hide* some of the "official" commands (like "info",
executable files with those names in this directory. So don't do that -- you
have been warned!**
<a name="A3"></a>
### anatomy of a command
You can basically do whatever you want in such a command -- go wild! It's
@ -130,8 +136,12 @@ convenient. See any of the other samples for how to use it.
If you don't like this, roll your own. If you don't like bash, do the eqvt in
your language of choice.
<a name="A4"></a>
### example uses and sample commands in contrib
<a name="A5"></a>
#### fork
A user would use the fork command like this:
@ -165,6 +175,8 @@ So now we have an actual command to just create a repo and do nothing else:
`ssh git@server git-init \'reponame\'`. [Yes; those single quotes are
required. Deal with it.]
<a name="A6"></a>
#### rmrepo
This is one thing that you really could not do before this setup was created.
@ -175,6 +187,8 @@ Use it like this:
The script checks to make sure that the repo being deleted was *created* by
the user invoking it.
<a name="A7"></a>
#### (bonus) restricted admin
It's rather important to me (and presumably others in the "corporate" world)