[gentoo-commits] gentoo commit in xml/htdocs/proj/en/overlays: devguide.xml

[Robin H. Johnson (robbat2)]

robbat2     08/10/12 09:40:34

  Modified:             devguide.xml
  Log:
  Update devguide to elevate Git to a first-class overlays SCM, with new instructions similar to git.overlays.gentoo.org. Remove the mention of Stu as project leader, since he retired long ago.

Revision  Changes    Path
1.11                 xml/htdocs/proj/en/overlays/devguide.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/overlays/devguide.xml?rev=1.11&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/overlays/devguide.xml?rev=1.11&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/overlays/devguide.xml?r1=1.10&r2=1.11

Index: devguide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/overlays/devguide.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -p -w -b -B -u -u -r1.10 -r1.11
--- devguide.xml	12 Oct 2008 09:23:30 -0000	1.10
+++ devguide.xml	12 Oct 2008 09:40:34 -0000	1.11
@@ -5,7 +5,13 @@
 <title>Gentoo Overlays: Developers' Guide</title>
 
 <author title="Author">
-  <mail link="stuart@g.o">Stuart Herbert</mail>
+  <mail link="stuart">Stuart Herbert</mail>
+</author>
+<author title="Author">
+  <mail link="jokey">Markus Ullmann</mail>
+</author>
+<author title="Author">
+  <mail link="robbat2">Robin H. Johnson</mail>
 </author>
 
 <abstract>This guide helps developers understand how to use the Gentoo
@@ -13,8 +19,8 @@ Overlays service.</abstract>
 
 <license/>
 
-<version>1.0</version>
-<date>2006-07-29</date>
+<version>2.0</version>
+<date>2008-10-12</date>
 
 <chapter>
 <title>Introduction</title>
@@ -51,15 +57,16 @@ overlay.</p>
 <p>The overlays.gentoo.org service currently provides:</p>
 <ul>
 <li><uri link="http://trac.edgewall.com">Trac</uri> (a wiki w/ integrated subversion browser), for quickly creating and maintaining documentation about your overlay</li>
-<li><uri link="http://subversion.tigris.org">Subversion</uri> - a centralised version control system (distributed version control systems will be supported in future)</li>
+<li><uri link="http://subversion.tigris.org">Subversion</uri> - a centralised version control system</li>
 <li>Publishing the changelog for your overlay on <uri link="http://overlays.gentoo.org/">the o.g.o homepage</uri>, so that everyone who's interested can see what's going on</li>
+<li><uri link="http://git.or.cz">Git</uri> - Fast Version Control System</li>
 </ul>
 
 <p>... all hosted on secure, backed-up Gentoo infrastructure, administered by
 <uri link="/proj/en/infrastructure">the Gentoo Infrastructure team</uri> (hardware / base OS) and <uri link="/proj/en/overlays">the Gentoo Overlays team</uri>
 (wiki / VCS / ACLs).</p>
 
-<p>Each overlay has separate authentication lists for Trac and for Subversion.
+<p>Each overlay has separate authentication lists for Trac, Subversion and Git.
 It's no problem at all to give someone write access to just Trac (e.g. for
 writing documentation) without giving them write access to Subversion.</p>
 </body>
@@ -140,13 +147,17 @@ metastructure document</uri>, which is G
 lead(s) are responsible for the project overlay, including its contents, and
 any problems it causes other Gentoo projects and developers.</p>
 
-<p>To request a project overlay, the project's lead just needs to pop into
+<p>To request a SVN project overlay, the project's lead just needs to pop into
 #gentoo-overlays on IRC and ask for an overlay to be created.  Or, if he/she
 prefers, drop an email to overlays@g.o.  We'll take care of the rest,
 including granting write access to all the members of your project (as listed
 on your project page).</p>
 
-<p>We will:</p>
+<p>To request a Git project overlay, just visit the <uri
+link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
+setup instructions, emailing the completed template as directed.</p>
+
+<p>For an SVN request, we will:</p>
 <ul>
 <li>create your overlay (trac site + svn)</li>
 <li>add your overlay's RSS feed to the o.g.o homepage</li>
@@ -157,6 +168,18 @@ repository</li>
 account</li>
 <li>contact all of the other project members, and sort out their access</li>
 </ul>
+
+<p>For an Git request, we will:</p>
+<ul>
+<li>create your overlay (git, no trac)</li>
+<li>add your overlay's RSS feed to the o.g.o homepage</li>
+<li>create an git.o.g.o account for you if you don't already have one</li>
+<li>give you write access to your overlays Git repository</li>
+<li>give write access to all project members who already have an o.g.o account</li>
+<li>contact all of the other project members, and sort out their access</li>
+</ul>
+
+
 </body>
 </section>
 
@@ -170,11 +193,15 @@ example is <uri link="http://overlays.ge
 <p>If you have an @gentoo.org email address, and you've passed the ebuild quiz,
 then you can have your own developer overlay on o.g.o.</p>
 
-<p>To request a developer overlay, just pop into #gentoo-overlays on IRC and ask
-for an overlay to be created for you.  Or, if you prefer, drop an email to
-overlays@g.o.</p>
+<p>To request a SVN developer overlay, just pop into #gentoo-overlays on IRC
+and ask for an overlay to be created for you.  Or, if you prefer, drop an email
+to overlays@g.o.</p>
+
+<p>To request a Git developer overlay, just visit the <uri
+link="http://git.overlays.gentoo.org">git.overlays</uri> site, and follow the
+setup instructions, emailing the completed template as directed.</p>
 
-<p>We will:</p>
+<p>For an SVN request, we will:</p>
 <ul>
 <li>create your overlay (trac site + svn)</li>
 <li>add your overlay's RSS feed to the o.g.o homepage</li>
@@ -182,6 +209,14 @@ overlays@g.o.</p>
 <li>give you write access to your overlay's Trac wiki and Subversion
 repository</li>
 </ul>
+
+<p>For an Git request, we will:</p>
+<ul>
+<li>create your overlay (git, no trac)</li>
+<li>add your overlay's RSS feed to the o.g.o homepage</li>
+<li>create an git.o.g.o account for you if you don't already have one</li>
+<li>give you write access to your overlays Git repository</li>
+</ul>
 </body>
 </section>
 
@@ -329,17 +364,6 @@ can then use Subversion (or Trac's timel
 <title>Using git on overlays</title>
 
 <section>
-<title>Setting up git for committing with webdav</title>
-<body>
-<pre caption="add to your ~/.netrc">
-machine overlays.gentoo.org
-login (your-username)
-password (your-password)
-</pre>
-<p>Source: http://www.kernel.org/pub/software/scm/git/docs/howto/setup-git-server-over-http.txt</p>
-</body>
-</section>
-<section>
 <title>Initializing your overlay</title>
 <body>
 <p>Before uploading you need to locally create a git repository and add all items:</p>
@@ -347,16 +371,16 @@ password (your-password)
 <pre caption="create a new git repo">git init
 git add .
 git commit -m "populate overlay"</pre>
-<p>Note that this commit was only locally, now we get the server into the game. Be sure to add the trailing /</p>
-<pre caption="tell git the url">git-config remote.upload.url http://(your-username)@overlays.gentoo.org/git/(proj or dev)/(name)/</pre>
-<pre caption="finally get it up there">git push upload master</pre>
+<p>Note that this commit was only locally, now we get the server into the game.</p>
+<pre caption="tell git the url">git remote add origin git+ssh://git@×××××××××××××××××××.org/(proj or dev)/(name)</pre>
+<pre caption="finally get it up there">git push origin master</pre>
 <p>Source: http://www.kernel.org/pub/software/scm/git/docs/tutorial.html</p>
 </body></section>
 
 <section>
 <title>Checking out the overlay with git</title>
 <body>
-<pre caption="clone it!">git clone http://overlays.gentoo.org/git/(proj or dev)/(name)/</pre>
+<pre caption="clone it!">git clone git://git@×××××××××××××××××××.org/(proj or dev)/(name)/</pre>
 </body>
 </section>
 </chapter>
@@ -519,14 +543,14 @@ arrange for you to have write access, by
    current staff are mostly in European timezones.</li>
 <li>A: You can send an email to overlays@g.o.  Someone will answer you as
    soon as possible.</li>
-<li>A: You can contact Stuart Herbert (the project leader) directly, via his
-   email address: stuart@g.o.</li>
 </ul>
 
 <p>Q: Why can't I edit the access control list directly?</p>
 <ul>
-<li>A: The access control list currently lives in htpasswd / htgroup files used
+<li>A: (SVN) The access control list currently lives in htpasswd / htgroup files used
    by Apache.  Only o.g.o admin staff have ssh access into the o.g.o box.</li>
+<li>A: (Git) The access control list currently lives in the gitosis-admin repository, 
+   which is writable only by the o.g.o staff.</li>
 </ul>
 </body>
 </section>