html/volunteers.html

   1 @section=site guide
   2 @heading=Volunteers
   3 @header
   4
   5 <!-- This file is preprocessed by cgi/html.cgi -->
   6
   7
   8 <p><em>At this time we are not actively looking for extra volunteers.</em></p>
   9
  10 <p>Who do we want:</p>
  11 <ul>
  12 <li>People with motivation to help out one of the largest public Git hosting
  13 sites who don't mind helping out some poor user once in a week and/or want
  14 to enhance repo.or.cz services and features while also fixing few bugs
  15 in the process</li>
  16 <li>People with reasonable experience in all of UNIX/GNU, shell scripting,
  17 Perl and Git itself</li>
  18 <li>Trustworthy persons with no bad history and preferrably some existing
  19 open-source community involvement - ideally (but not required) in the Git
  20 community</li>
  21 <li>People who don't mind working in a team, are willing to put up with
  22 a perfectionist <a href="mailto:pasky@ucw.cz">pasky</a> at the beginning
  23 and can get used to thinking thrice before doing something on the live
  24 database</li>
  25 </ul>
  26
  27 <p>What will you do (at least some of... ;-):</p>
  28 <ul>
  29 <li>Supporting users over email, possibly IRC. We get one support issue
  30 per week on average, usually project deletion requests.</li>
  31 <li>Other maintenance tasks - checking if jobs don't get stuck, possible
  32 project breakage, reviewing+applying patches from users, monitoring
  33 bogus content tags usage, cleaning up badly created projects and handling
  34 server overload (all fairly rare occurences)</li>
  35 <li>Implement gadgets to ease your maintenance tasks- could be e.g. issue
  36 tracking system or ability for users to remove projects themselves.</li>
  37 <li>Fix repo.or.cz bugs. E.g. the mirroring process gets stuck once in a while
  38 on misbehaving mirror source, and sometimes objects get lost during gc that
  39 shouldn't.</li>
  40 <li>Implement cool new features. E.g. something from the
  41 <a href="/w/girocco.git/blob/HEAD:/TODO">Girocco TODO list</a>,
  42 cleaning up and adding support for more mirroring source VCSes, user experience
  43 improvements, maybe some interesting statistical analysis...</li>
  44 </ul>
  45
  46 <p>What's in it for you:</p>
  47 <ul>
  48 <li>Most importantly, good warm feeling in your heart! ;-)</li>
  49 <li>Chance to play with a reasonably large site and try out interesting
  50 things.</li>
  51 <li>Learning more UNIX/shell/perl/git on a very practical project.</li>
  52 <li>Getting more involved in the Git development community, getting general
  53 experience with OSS development of something that's actually immediately useful.</li>
  54 <li>Low and totally flexible time demands.</li>
  55 <li>Nice CV point to be sure!</li>
  56 </ul>
  57
  58 <p>Are you interested? Please apply at <a href="mailto:pasky@ucw.cz">pasky@ucw.cz</a>.
  59 (Note: If you want to look at the current repo.or.cz codebase or even
  60 deploy a copy locally to play with, just look at <a href="/w/girocco.git">girocco.git</a>.)
  61
  62 <p>TODO: Make everything below this line less public. ;-)
  63 So far, no huge deal I guess.
  64 Volunteers can see what will they work with.</p>
  65
  66 <hr />
  67
  68 <h2>The Admin Team Plan</h2>
  69
  70 <p>These are pasky's ideas on how to set up the admin team and transfer
  71 control to it:</p>
  72
  73 <ul>
  74 <li>Gather feedback and confirmation from volunteers that already applied.</li>
  75 <li>Set up admin@repo.or.cz alias plus internal mailing list.</li>
  76 <li>Create accounts for new recruits with sudo access to the 'repo' account.
  77 (We just got a complete tree backup while migrating, so we can be liberal
  78 and relatively trusting at the beginning. ;)</li>
  79 <li>Let the new recruits start helping out and self-organizing. There will
  80 be probably need to create a deployment staging area and some cooperation
  81 rules to avoid race conditions, but I'd prefer the new admin team to already
  82 figure that out for themselves.</li>
  83 <li>Give the two or three most experienced members root access after a while.</li>
  84 <li>Pasky would like to stay in the loop and keep veto power for a while
  85 to protect the site from some bad deterioration or major turnovers.</li>
  86 </ul>
  87
  88 <p>New admins rules:</p>
  89
  90 <ul>
  91 <li>Do not be shy doing stuff. If you are not doing it, noone else probably
  92 is either. Just send a mail when you start doing something, and another
  93 when you are done.</li>
  94 <li>Document everything you do outside of your sandbox. On the mailing list
  95 for starters, we can figure out better book-keeping later. Reply on admin@
  96 to all user requests that you have handled.</li>
  97 <li>Ask for consultations and acks whenever you have shadow of doubt.</li>
  98 <li>Think trice. Avoid doing unrevertable things!</li>
  99 <li>Think once. Make plenty of non-destructive quick experiments to learn about
 100 stuff.</li>
 101 <li>No abuse. We need to nurture the goodwill of our connection sponsors.
 102 No peer-to-peer filesharing!</li>
 103 <li>Do not use Ctrl-C to quit screen. You could kill a task!</ul>
 104 </ul>
 105
 106 <hr />
 107
 108 <h2>Cookbook</h2>
 109
 110 <p>Working as <code>repo</code> user:</p>
 111
 112 <ul>
 113 <li>All infrastructure is owned by the repo user, and runs as repo (except
 114 web scripts, suexec is not set up - for now?)</li>
 115 <li><em>Always</em> work under the shared screen so others can check out who
 116 is working on what: <code>screen -x repo/admins</code>, this will get you to
 117 our shared screen session. jobd (updating mirrors, running gc) and taskd
 118 (creating mirrors, push notifications) run in the first two windows. Shells in
 119 screen are owned by user <code>repo</code></li>.
 120 <li>Live copy lives in <code>~/repomgr</code> and <code>~/WWW</code>,
 121 chroot jail for pushing is in <code>~/j</code>, codebase is in
 122 <code>~/repo</code>.</li>
 123 <li>Do <em>not</em> work directly in <code>~/repo</code>. If you want to
 124 edit files, clone <code>Girocco.git</code> and push after committing (and
 125 verifying) your changes locally.</li>
 126 <li>To update the live copy, <code>cd ~/repo</code>, <code>git pull</code>
 127 (should fast-forward), then <code>make install</code>.
 128 This will OVERWRITE complete <code>~/repomgr</code>!</li>
 129 </ul>
 130
 131 <p>New admins checklist:</p>
 132
 133 <ul>
 134 <li>Make yourself a <code>.forward</code> file so that you receive admin@ mail.</li>
 135 <li>Add yourself to <a href="/h/admins.html">the admin team page</a>,
 136 which is also a nice way to get comfortable with our girocco setup.</li>
 137 <li>Send a short introduction to admin@repo.or.cz.</li>
 138 <li>Take a look at the list of TODO items in rorcz branch of girocco. Perhaps you could tackle something right away?</li>
 139 <li>If you are bored, ask for some ideas! Or perhaps we can bounce to you some requests we did not have time to deal with. Don't be shy!</li>
 140 <li>Please check periodically that the jobd in screen window 0 is not stuck.</li>
 141 <li>Try to deal with something from <a href="/w/girocco.git/blob/rorcz:/TODO">the TODO list</a>.</li>
 142 </ul>
 143
 144 <p>Removing a project:</p>
 145
 146 <ul>
 147 <li>Philosophically, I'm not too happy to remove a project unless there's
 148 a good reason like turning it to a mirror or some consolidation or legal
 149 reasons (or it's almost empty); I believe in archiving everything. This position
 150 can change if others disagree.</li>
 151 <li><code>mv /srv/git/project.git /srv/git-recyclebin/</code> - move forks
 152 properly within the hierarchy, let pasky know in case of permissions problem
 153 (ALWAYS remove by mv to recyclebin, never by deleting the directory for good)</li>
 154 <li><code>vi ~repo/j/etc/group</code>, find the line for the project and
 155 remove it from the file. Don't keep the file open to avoid races.</li>
 156 </ul>
 157
 158 <p>Backups: There is a nightly rsync cronjob that backs up metadata to another
 159 machine (which is now physically in the same building so we should do something
 160 better long-term). No backlog is kept!</p>
 161
 162 <p>Other things running on the server:</p>
 163
 164 <ul>
 165 <li>Pasky stores some harmless data on the server. He may run some niced
 166 computations time by time if he thinks the server is really idle.</li>
 167 <li>There is a mailman instance running on the server that serves also
 168 a beekeepers' mailing list.</li>
 169 <li>The server provides slave DNS services for few domains.</li>
 170 <li>There is a compendium of RSS-&gt;IRC gateways for couple of Czech news servers.</li>
 171 <li>A tiny IRC bot + assorted services.</li>
 172 </ul>