diff --git a/README.mkd b/README.mkd index 6ccf976..b3d27d3 100644 --- a/README.mkd +++ b/README.mkd @@ -25,9 +25,10 @@ And [here][who]'s some information on some of the projects and people using gitolite (and who, in turn, have helped shape its features). Once you've installed it and started using it, you'll want to explore some of -the more powerful features. All the documentation is available in the source -repo as well as [online][docs]. All the longer documents have tables of -contents, so you can quickly get a feel for what is covered right at the top. +the more powerful features. **The documentation is best read [online +here][docs] or you can read it in your clone's `doc/` directory**. All the +longer documents have tables of contents, so you can quickly get a feel for +what is covered right at the top. ---- diff --git a/contrib/gerrit.mkd b/contrib/gerrit.mkd index d5ce017..d68c007 100644 --- a/contrib/gerrit.mkd +++ b/contrib/gerrit.mkd @@ -1,4 +1,4 @@ -# comparing gerrit and gitolite +## comparing gerrit and gitolite Gerrit and gitolite have too many high level differences. Size is most visible of course: 56000 lines of Java versus 1300 lines of perl+shell, diff --git a/contrib/gitolite-tools.mkd b/contrib/gitolite-tools.mkd index 887ff98..a3cab8e 100644 --- a/contrib/gitolite-tools.mkd +++ b/contrib/gitolite-tools.mkd @@ -1,4 +1,4 @@ -# gitolite-tools +## gitolite-tools gitolite-tools is a collection of external git commands to work with gitolite server and repositories: diff --git a/contrib/ldap/README.mkd b/contrib/ldap/README.mkd index 35c5c25..20725b4 100644 --- a/contrib/ldap/README.mkd +++ b/contrib/ldap/README.mkd @@ -1,4 +1,4 @@ -# ldap helper programs +## ldap helper programs These programs were contributed by the Nokia MeeGo folks. diff --git a/contrib/vim/README.mkd b/contrib/vim/README.mkd index ba6a000..c8fbd73 100644 --- a/contrib/vim/README.mkd +++ b/contrib/vim/README.mkd @@ -1,4 +1,4 @@ -# Vim Syntax Highlight +## Vim Syntax Highlight [Vim][] Syntax highlight for `gitolite.conf` can be found from: diff --git a/doc/admin-defined-commands.mkd b/doc/admin-defined-commands.mkd index 6dd03ab..0bcb1a1 100644 --- a/doc/admin-defined-commands.mkd +++ b/doc/admin-defined-commands.mkd @@ -1,4 +1,4 @@ -# admin defined commands +## admin defined commands **WARNING: Use this feature only if you really really know what you're doing. If you come back to me saying this feature caused a problem, I will only diff --git a/doc/big-config.mkd b/doc/big-config.mkd index 8efe72e..962b548 100644 --- a/doc/big-config.mkd +++ b/doc/big-config.mkd @@ -1,4 +1,4 @@ -# what is a "big-config" +## what is a "big-config" In this document: diff --git a/doc/delegation.mkd b/doc/delegation.mkd index a3b607b..b8594aa 100644 --- a/doc/delegation.mkd +++ b/doc/delegation.mkd @@ -1,4 +1,4 @@ -# delegating access control responsibilities +## delegating access control responsibilities [Thanks to jeromeag for forcing me to think through this...] diff --git a/doc/developer-notes.mkd b/doc/developer-notes.mkd index 0e204b7..1ab81ca 100644 --- a/doc/developer-notes.mkd +++ b/doc/developer-notes.mkd @@ -1,4 +1,4 @@ -# developer/patch maintainer notes +## developer/patch maintainer notes In this document: diff --git a/doc/hook-propagation.mkd b/doc/hook-propagation.mkd index d0ce3ae..d6285ac 100644 --- a/doc/hook-propagation.mkd +++ b/doc/hook-propagation.mkd @@ -1,4 +1,4 @@ -# hook propagation in gitolite +## hook propagation in gitolite Advanced users need to know how hooks propagate, and when. They also need to know where to place their hooks, and since there appear to be two places to diff --git a/doc/mirroring.mkd b/doc/mirroring.mkd index 8392923..3dc8382 100644 --- a/doc/mirroring.mkd +++ b/doc/mirroring.mkd @@ -1,4 +1,4 @@ -# mirroring a gitolite setup +## mirroring a gitolite setup Mirroring git repos is essentially a one-liner. For each mirror you want to update, you just add a post-receive hook that says diff --git a/doc/mob-branches.mkd b/doc/mob-branches.mkd index 757fff6..9001eed 100644 --- a/doc/mob-branches.mkd +++ b/doc/mob-branches.mkd @@ -1,4 +1,4 @@ -# mob branches in gitolite +## mob branches in gitolite WARNING: This is hairy stuff. But what's life without a little danger? diff --git a/doc/monkeysphere.mkd b/doc/monkeysphere.mkd index e613a9d..3497073 100644 --- a/doc/monkeysphere.mkd +++ b/doc/monkeysphere.mkd @@ -1,4 +1,4 @@ -(contributed doc: integrating gitolite with monkeysphere) +## (contributed doc: integrating gitolite with monkeysphere) This document attempts to describe one way to integrate [Monkeysphere](http://web.monkeysphere.info/) authentication diff --git a/doc/overkill.mkd b/doc/overkill.mkd index c71ccd6..9a41ca4 100644 --- a/doc/overkill.mkd +++ b/doc/overkill.mkd @@ -1,4 +1,4 @@ -# when gitolite is overkill +## when gitolite is overkill Note: I wrote this to help people for whom gitolite is genuinely overkill. I believe it will all work, but YMMV. diff --git a/doc/packaging.mkd b/doc/packaging.mkd index 8b51d72..c3c4b56 100644 --- a/doc/packaging.mkd +++ b/doc/packaging.mkd @@ -1,4 +1,4 @@ -# packaging gitolite +## packaging gitolite Here's how you'd package gitolite. In the following description, location "X" can be, say, `/usr/share/gitolite/conf` or some such, and similarly location diff --git a/doc/progit-article.mkd b/doc/progit-article.mkd index 1bd0183..f408d96 100644 --- a/doc/progit-article.mkd +++ b/doc/progit-article.mkd @@ -1,4 +1,4 @@ -(master copy of progit chapter on gitolite) +# (master copy of progit chapter on gitolite) ## Gitolite ## diff --git a/doc/shell-games.mkd b/doc/shell-games.mkd index c9a1e74..7685026 100644 --- a/doc/shell-games.mkd +++ b/doc/shell-games.mkd @@ -1,4 +1,4 @@ -# avoiding the shell on the server +## avoiding the shell on the server Gitolite now tries to prevent gitolite-admin push privileges from being used to obtain a shell on the server. This was not always the case (older gitolite diff --git a/doc/uninstall.mkd b/doc/uninstall.mkd index 9cbe829..5266a3c 100644 --- a/doc/uninstall.mkd +++ b/doc/uninstall.mkd @@ -1,4 +1,4 @@ -# uninstalling gitolite +## uninstalling gitolite Sometimes you might find gitolite is overkill -- you have only one user (yourself) pushing maybe. Or maybe gitolite is just not enough -- you want a diff --git a/doc/wildcard-repositories.mkd b/doc/wildcard-repositories.mkd index 3cfb580..b021ce5 100644 --- a/doc/wildcard-repositories.mkd +++ b/doc/wildcard-repositories.mkd @@ -1,4 +1,4 @@ -# repositories named with wildcards +## repositories named with wildcards ***IMPORTANT NOTE***: diff --git a/t/README.mkd b/t/README.mkd index 78b2ef4..2bbf0f8 100644 --- a/t/README.mkd +++ b/t/README.mkd @@ -1,4 +1,4 @@ -# notes on the testing setup +## notes on the testing setup In this document: