(doc) switch from mindmap to mkd...
we don't need the flexibility any more
This commit is contained in:
Sitaram Chamarty
parent
9006b07d2e
commit
95e6c2ae8b
94
doc/fm2mt.pl
94
doc/fm2mt.pl
|
|
@ -1,94 +0,0 @@
|
||||||
#!/usr/bin/perl
|
|
||||||
use strict;
|
|
||||||
use warnings;
|
|
||||||
use 5.10.0;
|
|
||||||
|
|
||||||
# usage: ./fm2mt.pl < g3-master-toc.mm > master-toc.mkd
|
|
||||||
|
|
||||||
use HTML::Entities;
|
|
||||||
|
|
||||||
sub out { my $out = shift; print $out; }
|
|
||||||
|
|
||||||
# freemind to "dense" HTML
|
|
||||||
my @in = fm2indent();
|
|
||||||
|
|
||||||
out("# gitolite documentation");
|
|
||||||
my $started = 0;
|
|
||||||
for (@in) {
|
|
||||||
my($indent, $text) = split ' ', $_, 2;
|
|
||||||
$indent--;
|
|
||||||
|
|
||||||
if (not $indent) {
|
|
||||||
out "\n\n## $text\n";
|
|
||||||
$started = 0;
|
|
||||||
next;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($indent == 1) {
|
|
||||||
# (dense mode) $text = color("red", $text);
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($indent <= 2) {
|
|
||||||
# (dense mode) $text = size(2 - $indent, $text);
|
|
||||||
} else {
|
|
||||||
# 3 or more
|
|
||||||
# (dense mode) $text = ("/" x ($indent-4)) . color("gray", $text);
|
|
||||||
}
|
|
||||||
|
|
||||||
# normal mode
|
|
||||||
$text = "\n" . (" " x ($indent-1)) . " * $text";
|
|
||||||
# (dense mode) out " -- " if $started++;
|
|
||||||
out $text;
|
|
||||||
}
|
|
||||||
|
|
||||||
sub size {
|
|
||||||
my ($s, $t) = @_;
|
|
||||||
return "<font size=\"+" . $s . "\">$t</font>" if $s;
|
|
||||||
return $t;
|
|
||||||
}
|
|
||||||
|
|
||||||
sub color {
|
|
||||||
my ($c, $t) = @_;
|
|
||||||
return "<font color=\"$c\">$t</font>";
|
|
||||||
}
|
|
||||||
|
|
||||||
sub get_indent {
|
|
||||||
my $_ = shift;
|
|
||||||
chomp;
|
|
||||||
return () unless /\S/;
|
|
||||||
if (/^(#+) (.*)/) {
|
|
||||||
return (length($1)-1, $2);
|
|
||||||
}
|
|
||||||
if (/^( +) \* (.*)/) {
|
|
||||||
my $t = $2;
|
|
||||||
my $i = length($1);
|
|
||||||
die 1 if $i % 4;
|
|
||||||
$i = $i/4 + 3;
|
|
||||||
|
|
||||||
return ($i, $t);
|
|
||||||
}
|
|
||||||
return ();
|
|
||||||
}
|
|
||||||
|
|
||||||
sub fm2indent {
|
|
||||||
my @out = ();
|
|
||||||
my $indent=0;
|
|
||||||
|
|
||||||
while (<>)
|
|
||||||
{
|
|
||||||
next unless /^<node / or /^<\/node/;
|
|
||||||
if (/^<\/node>$/)
|
|
||||||
{
|
|
||||||
$indent--;
|
|
||||||
next;
|
|
||||||
}
|
|
||||||
next unless /TEXT="([^"]*)"/;
|
|
||||||
my $text = decode_entities($1);
|
|
||||||
|
|
||||||
push @out, "\n$indent $text" if $indent;
|
|
||||||
|
|
||||||
$indent++ unless (/\/>/);
|
|
||||||
}
|
|
||||||
|
|
||||||
return @out;
|
|
||||||
}
|
|
||||||
|
|
@ -1,160 +0,0 @@
|
||||||
<map version="0.9.0">
|
|
||||||
<!-- To view this file, download free mind mapping software FreeMind from http://freemind.sourceforge.net -->
|
|
||||||
<node CREATED="1331107648858" ID="ID_187992057" MODIFIED="1333299050498" TEXT="g3-master-index">
|
|
||||||
<node CREATED="1333299038338" ID="ID_1574733847" MODIFIED="1333536460445" POSITION="right" TEXT="[Introduction][index]">
|
|
||||||
<node CREATED="1333466035663" ID="ID_974293172" MODIFIED="1333536536267" TEXT="(for [current][g2] gitolite (v2) users)"/>
|
|
||||||
<node CREATED="1333466047943" ID="ID_1283272433" MODIFIED="1333536530576" TEXT="[quick links][ql]"/>
|
|
||||||
<node CREATED="1333326589821" ID="ID_195282410" MODIFIED="1333340829999" TEXT="[what][] is gitolite"/>
|
|
||||||
<node CREATED="1333326593927" ID="ID_1110367572" MODIFIED="1333340841907" TEXT="[why][] might you need it"/>
|
|
||||||
<node CREATED="1333536552704" ID="ID_1607033994" MODIFIED="1333536835577" TEXT="[contact][] info, mailing list, IRC channel"/>
|
|
||||||
<node CREATED="1333536577819" ID="ID_1858469252" MODIFIED="1333536835576" TEXT="[license][] info"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300010980" ID="ID_1728019284" MODIFIED="1333616327427" POSITION="right" TEXT="help for [emergencies][]">
|
|
||||||
<node CREATED="1333300016176" ID="ID_30257493" MODIFIED="1333453799784" TEXT="[lost][lost-key] admin key/access"/>
|
|
||||||
<node CREATED="1333327185236" ID="ID_910862972" MODIFIED="1333471145297" TEXT="[bypass][]ing gitolite"/>
|
|
||||||
<node CREATED="1333328183948" ID="ID_564351456" MODIFIED="1333453834497" TEXT="[clean][]ing out a botched install"/>
|
|
||||||
<node CREATED="1333326808789" ID="ID_54380370" MODIFIED="1333631901528" TEXT="[common][ce] errors (TBD)"/>
|
|
||||||
<node CREATED="1333597279461" ID="ID_547537696" MODIFIED="1333631907824" TEXT="[uncommon][ue] errors"/>
|
|
||||||
<node CREATED="1333328539885" ID="ID_162892604" MODIFIED="1333527642132" TEXT="things that are [not gitolite problems][ngp]"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333466070125" ID="ID_1329733023" MODIFIED="1333527838066" POSITION="right" TEXT="[WARNINGS][]"/>
|
|
||||||
<node CREATED="1333326560775" ID="ID_1030406941" MODIFIED="1333631954561" POSITION="right" TEXT="[quick][qi] install, setup, and clone"/>
|
|
||||||
<node CREATED="1333465293309" ID="ID_1405252383" MODIFIED="1333526188455" POSITION="right" TEXT="[install][]">
|
|
||||||
<node CREATED="1333327826145" ID="ID_519306224" MODIFIED="1333467083667" TEXT="notes and naming conventions"/>
|
|
||||||
<node CREATED="1333328069297" ID="ID_624460163" MODIFIED="1333465312762" TEXT="requirements">
|
|
||||||
<node CREATED="1333328127550" ID="ID_368487912" MODIFIED="1333537067223" TEXT="your skills"/>
|
|
||||||
<node CREATED="1333328123855" ID="ID_1146334636" MODIFIED="1333339551947" TEXT="server"/>
|
|
||||||
<node CREATED="1333328126057" ID="ID_899541385" MODIFIED="1333328127275" TEXT="client"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333328151051" ID="ID_1577506173" MODIFIED="1333465323159" TEXT="getting the software"/>
|
|
||||||
<node CREATED="1333328156575" ID="ID_208746322" MODIFIED="1333465333727" TEXT="the actual install"/>
|
|
||||||
<node CREATED="1333467553366" ID="ID_926614739" MODIFIED="1333467556140" TEXT="upgrading"/>
|
|
||||||
<node CREATED="1333328592876" ID="ID_237795046" MODIFIED="1333466108368" TEXT="packaging gitolite"/>
|
|
||||||
<node CREATED="1333327776230" ID="ID_1431739921" MODIFIED="1334308813624" TEXT="[migr][]ating"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333301194129" ID="ID_746196740" MODIFIED="1333471816303" POSITION="right" TEXT="[setup][]"/>
|
|
||||||
<node CREATED="1333299674481" ID="ID_714407264" MODIFIED="1333528325006" POSITION="right" TEXT="gitolite [admin][]istration">
|
|
||||||
<node CREATED="1333299694885" ID="ID_1916098884" MODIFIED="1333537908466" TEXT="[server][]-side">
|
|
||||||
<node CREATED="1333327917312" ID="ID_1266878047" MODIFIED="1333537539764" TEXT="([link][WARNINGS]: important cautions on server side activity)"/>
|
|
||||||
<node CREATED="1333301196071" ID="ID_760433725" MODIFIED="1333537537075" TEXT="changing settings in the [rc][] file"/>
|
|
||||||
<node CREATED="1333537546089" ID="ID_2500021" MODIFIED="1333537553267" TEXT="installing custom [hooks][]"/>
|
|
||||||
<node CREATED="1333537563152" ID="ID_472486055" MODIFIED="1333537616205" TEXT="([link][existing]: moving existing repos into gitolite)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333299702754" ID="ID_609351656" MODIFIED="1333537921248" TEXT="[access control][conf] (the gitolite.conf file)">
|
|
||||||
<node CREATED="1333566502470" ID="ID_1931486515" MODIFIED="1333583575642" TEXT="[example][confex] of a conf file"/>
|
|
||||||
<node CREATED="1333300715360" ID="ID_41940351" MODIFIED="1333547591053" TEXT="basic [syntax][]">
|
|
||||||
<node CREATED="1333300732151" ID="ID_1494555007" MODIFIED="1333300733944" TEXT="include files"/>
|
|
||||||
<node CREATED="1333300741424" ID="ID_416012685" MODIFIED="1333513004487" TEXT="([link][sugar]: syntactic sugar)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300461624" ID="ID_1848362678" MODIFIED="1333529103568" TEXT="[groups][] (of users and repos)">
|
|
||||||
<node CREATED="1333300884900" ID="ID_1412135290" MODIFIED="1333300893755" TEXT="special: '@all'"/>
|
|
||||||
<node CREATED="1333300437860" ID="ID_897670108" MODIFIED="1333300770020" TEXT="(link: storing user group info in LDAP)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333299715546" ID="ID_1916374076" MODIFIED="1333529107922" TEXT="adding and removing [users][]">
|
|
||||||
<node CREATED="1333326840977" ID="ID_1723439755" MODIFIED="1333517370375" TEXT="multiple keys per user"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333299719741" ID="ID_275665792" MODIFIED="1333529112764" TEXT="adding and removing [repos][]">
|
|
||||||
<node CREATED="1333327426500" ID="ID_1964948889" MODIFIED="1333518450199" TEXT="renaming repos"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300309235" ID="ID_1437714859" MODIFIED="1333529121211" TEXT="defining access [rules][]">
|
|
||||||
<node CREATED="1333584760127" ID="ID_469376519" MODIFIED="1333584767343" TEXT="what does a rule look like?"/>
|
|
||||||
<node CREATED="1333326976405" ID="ID_563906836" MODIFIED="1333584770230" TEXT="when are the rules checked?"/>
|
|
||||||
<node CREATED="1333535584526" ID="ID_957313656" MODIFIED="1333584774497" TEXT="how are the rules matched?"/>
|
|
||||||
<node CREATED="1333301045521" ID="ID_1228046254" MODIFIED="1333536127886" TEXT="summary of [permissions][perms]"/>
|
|
||||||
<node CREATED="1333599586661" ID="ID_1785519868" MODIFIED="1333599590134" TEXT="additional topics">
|
|
||||||
<node CREATED="1333599591055" ID="ID_1379421123" MODIFIED="1333599606966" TEXT="[rule accumulation][rule-accum]"/>
|
|
||||||
<node CREATED="1333599613910" ID="ID_1760840175" MODIFIED="1333599634987" TEXT="applying [deny rules][deny-rules] during the pre-git check"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333535705100" ID="ID_1768473150" MODIFIED="1333535718347" TEXT="([link][refex]: refexes)"/>
|
|
||||||
<node CREATED="1333535719180" ID="ID_431454064" MODIFIED="1333626093118" TEXT="([link][write-types]: different types of write operations)"/>
|
|
||||||
<node CREATED="1333300541352" ID="ID_1407372791" MODIFIED="1333536011832" TEXT="([link][vref]: virtual refs)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333521966550" ID="ID_462181887" MODIFIED="1333529126015" TEXT="gitolite [options][]"/>
|
|
||||||
<node CREATED="1333521972558" ID="ID_1180232837" MODIFIED="1333536152124" TEXT=""[git config][git-config]" keys and values"/>
|
|
||||||
<node CREATED="1333299726939" ID="ID_1229702100" MODIFIED="1333601090414" TEXT="["wild"][wild] repos (user created repos)">
|
|
||||||
<node CREATED="1333329088398" ID="ID_533855844" MODIFIED="1333630553509" TEXT="quick introduction"/>
|
|
||||||
<node CREATED="1333599529910" ID="ID_1393418948" MODIFIED="1333630403135" TEXT="(admin) declaring wild repos in the conf file"/>
|
|
||||||
<node CREATED="1333629999807" ID="ID_139250181" MODIFIED="1333630432141" TEXT="(user) [creating][create] a specific repo"/>
|
|
||||||
<node CREATED="1333599928516" ID="ID_439610891" MODIFIED="1333600901677" TEXT="repo patterns"/>
|
|
||||||
<node CREATED="1333329137043" ID="ID_1876270574" MODIFIED="1333599539626" TEXT="roles"/>
|
|
||||||
<node CREATED="1333329119800" ID="ID_1196899132" MODIFIED="1333600898568" TEXT="adding other roles">
|
|
||||||
<node CREATED="1333630582435" ID="ID_792555451" MODIFIED="1333630596161" TEXT="[IMPORTANT WARNING ABOUT THIS FEATURE][rolenamewarn]"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333299760157" ID="ID_1787203633" MODIFIED="1333600934866" TEXT="listing wild repos"/>
|
|
||||||
<node CREATED="1333299751513" ID="ID_1503072743" MODIFIED="1333600958915" TEXT="deleting wild repos"/>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333326619348" ID="ID_697668065" MODIFIED="1333537363837" POSITION="right" TEXT="what your [user][]s need to know"/>
|
|
||||||
<node CREATED="1333300236173" ID="ID_1026631043" MODIFIED="1333607025161" POSITION="right" TEXT="[special][] features/setups">
|
|
||||||
<node CREATED="1333327232490" ID="ID_849345095" MODIFIED="1333631333199" TEXT="[disabling pushes][writable] to take backups"/>
|
|
||||||
<node CREATED="1333300243659" ID="ID_106425369" MODIFIED="1333604404937" TEXT="[personal][pers] branches"/>
|
|
||||||
<node CREATED="1333300501314" ID="ID_1819387758" MODIFIED="1333606161557" TEXT="[delegating][deleg] access control responsibilities">
|
|
||||||
<node CREATED="1333606177736" ID="ID_1153299625" MODIFIED="1333606191734" TEXT="([link][NAME]: the NAME VREF)"/>
|
|
||||||
<node CREATED="1333300531135" ID="ID_206710372" MODIFIED="1333606536438" TEXT="the [subconf][] command"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300925828" ID="ID_1848845001" MODIFIED="1333626115598" TEXT="([link][partial-copy]: faking selective READ control)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333327469941" ID="ID_1230549116" MODIFIED="1333607053576" POSITION="right" TEXT="interfacing with [external][] tools">
|
|
||||||
<node CREATED="1333327476469" ID="ID_1887257091" MODIFIED="1333327480072" TEXT="gitweb">
|
|
||||||
<node CREATED="1333504877358" ID="ID_1448276401" MODIFIED="1333625357439" TEXT="changing the [UMASK][umask]"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333327480559" ID="ID_513431483" MODIFIED="1333327483014" TEXT="git-daemon"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333326753755" ID="ID_16865998" MODIFIED="1333625410973" POSITION="right" TEXT="[mirroring][]"/>
|
|
||||||
<node CREATED="1333299976094" ID="ID_1948442779" MODIFIED="1333625437290" POSITION="right" TEXT="[rare][]/one-time activities">
|
|
||||||
<node CREATED="1333299985915" ID="ID_530631392" MODIFIED="1333471109149" TEXT="moving [existing][] repos into gitolite"/>
|
|
||||||
<node CREATED="1333300099453" ID="ID_1521618753" MODIFIED="1333625463686" TEXT="[moving][] servers"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333299141061" ID="ID_37630832" MODIFIED="1333625569805" POSITION="right" TEXT="[customisation][cust]">
|
|
||||||
<node CREATED="1333299458493" ID="ID_992003929" MODIFIED="1333625583059" TEXT="types of non-core programs">
|
|
||||||
<node CREATED="1333625624553" ID="ID_1205434644" MODIFIED="1333639834277" TEXT="([link][non-core]: non-core programs shipped with gitolite)"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333625674563" ID="ID_603892527" MODIFIED="1333625679247" TEXT="[commands][]"/>
|
|
||||||
<node CREATED="1333625679584" ID="ID_230664255" MODIFIED="1333625682401" TEXT="[hooks][]"/>
|
|
||||||
<node CREATED="1333625689987" ID="ID_112339937" MODIFIED="1333625696128" TEXT="syntactic [sugar][]"/>
|
|
||||||
<node CREATED="1333625703698" ID="ID_1165978069" MODIFIED="1333625715099" TEXT="([link][triggers]: triggers)"/>
|
|
||||||
<node CREATED="1333625717605" ID="ID_1483309372" MODIFIED="1333625734532" TEXT="([link][vref]: VREFs)"/>
|
|
||||||
<node CREATED="1333625757836" ID="ID_1102952567" MODIFIED="1333625766871" TEXT="[developer notes][dev-notes]">
|
|
||||||
<node CREATED="1333625797339" ID="ID_1760918724" MODIFIED="1333625812051" TEXT="environment variables and other inputs"/>
|
|
||||||
<node CREATED="1333625816655" ID="ID_420128580" MODIFIED="1333625818681" TEXT="APIs">
|
|
||||||
<node CREATED="1333625820871" ID="ID_672321981" MODIFIED="1333625823262" TEXT="the shell API"/>
|
|
||||||
<node CREATED="1333625823632" ID="ID_206993094" MODIFIED="1333625825547" TEXT="the perl API"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333625864473" ID="ID_1009525945" MODIFIED="1333625888705" TEXT="writing your own...">
|
|
||||||
<node CREATED="1333625889803" ID="ID_323248071" MODIFIED="1333625890797" TEXT="hooks"/>
|
|
||||||
<node CREATED="1333625891081" ID="ID_774724756" MODIFIED="1333625895322" TEXT="commands"/>
|
|
||||||
<node CREATED="1333625956866" ID="ID_1107908272" MODIFIED="1333625960910" TEXT="trigger programs"/>
|
|
||||||
<node CREATED="1333625961452" ID="ID_159826002" MODIFIED="1333625967173" TEXT="sugar"/>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1334308529127" ID="ID_1328767320" MODIFIED="1334308538750" POSITION="right" TEXT="[non-core][] programs shipped with gitolite">
|
|
||||||
<node CREATED="1334308547171" ID="ID_1481929835" MODIFIED="1334308550136" TEXT="commands"/>
|
|
||||||
<node CREATED="1334308552822" ID="ID_1632638638" MODIFIED="1334308556005" TEXT="syntactic sugar"/>
|
|
||||||
<node CREATED="1334308559968" ID="ID_759401290" MODIFIED="1334308561948" TEXT="triggers"/>
|
|
||||||
<node CREATED="1334308570911" ID="ID_118147118" MODIFIED="1334308585866" TEXT="([link][vref]: VREFs)"/>
|
|
||||||
<node CREATED="1334308589293" ID="ID_843158319" MODIFIED="1334308591424" TEXT="special cases">
|
|
||||||
<node CREATED="1334308633132" ID="ID_1213286105" MODIFIED="1334308757373" TEXT="[partial-copy][]: selective read control for branches"/>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300577608" ID="ID_583410113" MODIFIED="1333537235253" POSITION="right" TEXT="background info">
|
|
||||||
<node CREATED="1333299088617" ID="ID_1919571562" MODIFIED="1333537208005" TEXT="[files and directories][files] involved in install+setup"/>
|
|
||||||
<node CREATED="1333300378018" ID="ID_584192327" MODIFIED="1333536676126" TEXT="[auth][]entication versus authorisation">
|
|
||||||
<node CREATED="1333300390847" ID="ID_384452374" MODIFIED="1333453722001" TEXT="interfacing with [other authentication][otherauth] systems"/>
|
|
||||||
<node CREATED="1333300437860" ID="ID_99922512" MODIFIED="1333453750215" TEXT="getting user group info from [LDAP][ldap]"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333301124871" ID="ID_931083276" MODIFIED="1333453771459" TEXT="[ssh][]"/>
|
|
||||||
<node CREATED="1333301127955" ID="ID_1527577153" MODIFIED="1333453780482" TEXT="[regular expressions][regex]"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333300587911" ID="ID_91544543" MODIFIED="1333641141649" POSITION="right" TEXT="contributed software, tools, and documentation">
|
|
||||||
<node CREATED="1333300608550" ID="ID_1486318266" MODIFIED="1333626152668" TEXT="TBD"/>
|
|
||||||
</node>
|
|
||||||
<node CREATED="1333301296248" ID="ID_571518549" MODIFIED="1333526198202" POSITION="right" TEXT="TBD">
|
|
||||||
<node CREATED="1333327082853" ID="ID_488765250" MODIFIED="1333327089444" TEXT="log file format, LOG_EXTRA"/>
|
|
||||||
<node CREATED="1333301308136" ID="ID_1900285587" MODIFIED="1333301311863" TEXT="hub"/>
|
|
||||||
<node CREATED="1333328274461" ID="ID_248606591" MODIFIED="1333328277083" TEXT="mob branches"/>
|
|
||||||
<node CREATED="1333328277387" ID="ID_1027016949" MODIFIED="1333328280083" TEXT="password access"/>
|
|
||||||
</node>
|
|
||||||
</node>
|
|
||||||
</map>
|
|
||||||
162
doc/master-toc.mkd
Normal file
162
doc/master-toc.mkd
Normal file
|
|
@ -0,0 +1,162 @@
|
||||||
|
# gitolite documentation
|
||||||
|
|
||||||
|
## [Introduction][index]
|
||||||
|
|
||||||
|
* (for [current][g2] gitolite (v2) users)
|
||||||
|
* [quick links][ql]
|
||||||
|
* [what][] is gitolite
|
||||||
|
* [why][] might you need it
|
||||||
|
* [contact][] info, mailing list, IRC channel
|
||||||
|
* [license][] info
|
||||||
|
|
||||||
|
## help for [emergencies][]
|
||||||
|
|
||||||
|
* [lost][lost-key] admin key/access
|
||||||
|
* [bypass][]ing gitolite
|
||||||
|
* [clean][]ing out a botched install
|
||||||
|
* [common][ce] errors (TBD)
|
||||||
|
* [uncommon][ue] errors
|
||||||
|
* things that are [not gitolite problems][ngp]
|
||||||
|
|
||||||
|
## [WARNINGS][]
|
||||||
|
|
||||||
|
|
||||||
|
## [trying][] out gitolite
|
||||||
|
|
||||||
|
|
||||||
|
## [quick][qi] install, setup, and clone
|
||||||
|
|
||||||
|
|
||||||
|
## [install][]
|
||||||
|
|
||||||
|
* notes and naming conventions
|
||||||
|
* requirements
|
||||||
|
* your skills
|
||||||
|
* server
|
||||||
|
* client
|
||||||
|
* getting the software
|
||||||
|
* the actual install
|
||||||
|
* upgrading
|
||||||
|
* packaging gitolite
|
||||||
|
* [migr][]ating
|
||||||
|
|
||||||
|
## [setup][]
|
||||||
|
|
||||||
|
|
||||||
|
## gitolite [admin][]istration
|
||||||
|
|
||||||
|
* [server][]-side
|
||||||
|
* ([link][WARNINGS]: important cautions on server side activity)
|
||||||
|
* changing settings in the [rc][] file
|
||||||
|
* installing custom [hooks][]
|
||||||
|
* ([link][existing]: moving existing repos into gitolite)
|
||||||
|
* [access control][conf] (the gitolite.conf file)
|
||||||
|
* [example][confex] of a conf file
|
||||||
|
* basic [syntax][]
|
||||||
|
* include files
|
||||||
|
* ([link][sugar]: syntactic sugar)
|
||||||
|
* [groups][] (of users and repos)
|
||||||
|
* special: '@all'
|
||||||
|
* (link: storing user group info in LDAP)
|
||||||
|
* adding and removing [users][]
|
||||||
|
* multiple keys per user
|
||||||
|
* adding and removing [repos][]
|
||||||
|
* renaming repos
|
||||||
|
* defining access [rules][]
|
||||||
|
* what does a rule look like?
|
||||||
|
* when are the rules checked?
|
||||||
|
* how are the rules matched?
|
||||||
|
* summary of [permissions][permsum]
|
||||||
|
* additional topics
|
||||||
|
* [rule accumulation][rule-accum]
|
||||||
|
* applying [deny rules][deny-rules] during the pre-git check
|
||||||
|
* ([link][refex]: refexes)
|
||||||
|
* ([link][write-types]: different types of write operations)
|
||||||
|
* ([link][vref]: virtual refs)
|
||||||
|
* gitolite [options][]
|
||||||
|
* "[git config][git-config]" keys and values
|
||||||
|
* ["wild"][wild] repos (user created repos)
|
||||||
|
* quick introduction
|
||||||
|
* (admin) declaring wild repos in the conf file
|
||||||
|
* (user) [creating][create] a specific repo
|
||||||
|
* repo patterns
|
||||||
|
* roles
|
||||||
|
* adding other roles
|
||||||
|
* [IMPORTANT WARNING ABOUT THIS FEATURE][rolenamewarn]
|
||||||
|
* listing wild repos
|
||||||
|
* deleting wild repos
|
||||||
|
|
||||||
|
## what your [user][]s need to know
|
||||||
|
|
||||||
|
|
||||||
|
## [special][] features/setups
|
||||||
|
|
||||||
|
* [disabling pushes][writable] to take backups
|
||||||
|
* [personal][pers] branches
|
||||||
|
* [delegating][deleg] access control responsibilities
|
||||||
|
* ([link][NAME]: the NAME VREF)
|
||||||
|
* the [subconf][] command
|
||||||
|
* ([link][partial-copy]: faking selective READ control)
|
||||||
|
|
||||||
|
## interfacing with [external][] tools
|
||||||
|
|
||||||
|
* gitweb
|
||||||
|
* changing the [UMASK][umask]
|
||||||
|
* git-daemon
|
||||||
|
|
||||||
|
## [mirroring][]
|
||||||
|
|
||||||
|
|
||||||
|
## [rare][]/one-time activities
|
||||||
|
|
||||||
|
* moving [existing][] repos into gitolite
|
||||||
|
* [moving][] servers
|
||||||
|
|
||||||
|
## [customisation][cust]
|
||||||
|
|
||||||
|
* types of non-core programs
|
||||||
|
* ([link][non-core]: non-core programs shipped with gitolite)
|
||||||
|
* [commands][]
|
||||||
|
* [hooks][]
|
||||||
|
* syntactic [sugar][]
|
||||||
|
* ([link][triggers]: triggers)
|
||||||
|
* ([link][vref]: VREFs)
|
||||||
|
* [developer notes][dev-notes]
|
||||||
|
* environment variables and other inputs
|
||||||
|
* APIs
|
||||||
|
* the shell API
|
||||||
|
* the perl API
|
||||||
|
* writing your own...
|
||||||
|
* hooks
|
||||||
|
* commands
|
||||||
|
* trigger programs
|
||||||
|
* sugar
|
||||||
|
|
||||||
|
## [non-core][] programs shipped with gitolite
|
||||||
|
|
||||||
|
* commands
|
||||||
|
* syntactic sugar
|
||||||
|
* triggers
|
||||||
|
* ([link][vref]: VREFs)
|
||||||
|
* special cases
|
||||||
|
* [partial-copy][]: selective read control for branches
|
||||||
|
|
||||||
|
## background info
|
||||||
|
|
||||||
|
* [files and directories][files] involved in install+setup
|
||||||
|
* [auth][]entication versus authorisation
|
||||||
|
* interfacing with [other authentication][otherauth] systems
|
||||||
|
* getting user group info from [LDAP][ldap]
|
||||||
|
* [ssh][]
|
||||||
|
* [regular expressions][regex]
|
||||||
|
|
||||||
|
## contributed software, tools, and documentation
|
||||||
|
|
||||||
|
* TBD
|
||||||
|
|
||||||
|
## TBD
|
||||||
|
|
||||||
|
* log file format, LOG_EXTRA
|
||||||
|
* hub
|
||||||
|
* mob branches
|
||||||
|
* password access
|
||||||
Loading…
Reference in a new issue