[Debian-NP-Commits] r173 - trunk/docs/report/report-docbook

micah debian-np-devel@lists.alioth.debian.org
Thu, 15 Jul 2004 12:16:17 -0600


Author: micah-guest
Date: Thu Jul 15 12:16:17 2004
New Revision: 173

Modified:
   trunk/docs/report/report-docbook/appendix-development_environment.xml
Log:
First draft of this Appendix, doesn't validate, not sure how to use some
tags, need some mako help


Modified: trunk/docs/report/report-docbook/appendix-development_environment.xml
==============================================================================
--- trunk/docs/report/report-docbook/appendix-development_environment.xml	(original)
+++ trunk/docs/report/report-docbook/appendix-development_environment.xml	Thu Jul 15 12:16:17 2004
@@ -0,0 +1,187 @@
+<?xml version="1.0" encoding='UTF-8'?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "docbookx.dtd">
+
+<appendix>
+ <title>Appendix C: Development Environment</title>
+  <sect1>
+    <title>Subversion repository</title>
+    
+    <sect2>
+      <title>Overview</title>
+
+      <para>Subversion is a version control system. Version control is
+      a method to manage changes to information, it is a critical tool
+      for programmers who make many small changes to software in a
+      collaborative environment and require the ability to record why
+      they made a particular change, and return to a previous version
+      if necessary.</para>
+
+
+      <para>Subversion is a free software version control system that
+      aids developers in managing files, directories, source code,
+      documents, etc. over time. Files are created in a repository
+      which remembers every change ever made to any file or directory
+      within the repository, allowing you to recover older versions of
+      your data, examine the history of how your data changed, or undo
+      incorrect changes.</para>
+
+      <para>An additional benefit to using a version control system
+      like Subversion is that the repository is accessible over a
+      network, and is shared by developers. This allows for individual
+      developers to make changes to the same files from different
+      locations, fostering remote collaboration. Development progress
+      can occur quickly when each developer can work on the same files
+      at the same time, without the overhead of worrying about what
+      another might be doing to the same file, differences can be
+      merged and conflicts can be reconciled with ease.</para>
+
+      <para>Debian-NP created a Subversion repository at Debconf4,
+      learned how to use it and rapidly began populating it with our
+      work, and organizing its layout. Over the course of less than a
+      week, there were nearly 400 commitments made to the subversion
+      repository with code-fragments, documentation, meta-package
+      work, installer work, and organization of the repository. We
+      left the conference with a method of continuing our
+      collaborative in-person work through using Subversion, and an
+      impressive feeling of initiative manifested in the repository's
+      contents which we took home and continue to work with.</para>
+
+    </sect2>
+
+    <sect2>
+      <title>Usage</title>
+      <sect3>
+	<title>Alioth</title>
+	
+	<para>The Debian-NP Subversion repository requires that you
+	have an account on Alioth. Alioth is a free service to Debian
+	project developers offering easy access to the best in version
+	control, mailing lists, bug tracking, message boards/forums,
+	task management, site hosting, permanent file archival, full
+	backups, and total web-based administration. It is not
+	necessary to be an official Debian Developer to create an
+	account on Alioth, each person who came to Debconf4 to work on
+	Debian-NP created their Alioth account and were added to the
+	Debian-NP project.</para>
+
+	<para>To create an Alioth account, visit <ulink url="http://alioth.debian.org/account/register.php">Alioth.</ulink> </para>	
+      </sect3>
+
+      <sect3>
+	<title>Subversion client</title> 
+	
+	<para>You also need to have the Subversion client program
+	installed on your machine to be able to check out the
+	Debian-NP Subversion repository. Once you have Subversion
+	installed, you can check out the repository by issuing the
+	following command:</para>
+      </sect3>
+
+      <sect3>
+	<title>Subversion repository checkout</title>
+	
+	<para> INSERT SUBVERSION CHECKOUT COMMAND HERE </para>
+      </sect3>
+
+    <sect2>
+      <title>Layout</title>
+
+      <para>The Subversion repository was organized to a common work
+      area, structured around common development standards as well as
+      around what we are trying to accomplish, the agreed upon
+      framework that was put together is as follows:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para><code>branches/</code></para>
+	  <para>This is where concurrent development/stabilization
+	  happens.</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>people/</code></para>
+	  <para>Contains individual users working directories</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>tags/</code></para>
+	  <para>This is where static copies of package versions and
+	  other modules are stored.</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>trunk/</code></para>
+	  <para>This is used for mainline development.</para>
+	</listitem>
+
+      </itemizedlist>	  
+
+      <para>Inside <code>trunk/</code> are the following directories:</para>
+      
+      <itemizedlist>
+	<listitem>
+	  <para><code>docs/</code></para>
+	  <para>Contains common documentation, HOWTOs, etc.</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>packages/</code></para>
+	  <para>Storage of source packages that will need to be
+	  uploaded to Debian.</para>
+	</listitem>
+	
+      </itemizedlist>
+
+      <para>Inside the <code>packages/</code> hierarchy is located the
+      individual components of DebianNP:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para><code>debian-np/</code></para>
+	  <para>This directory contains the source code and
+	  definitions of the meta-packages</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>debian-np-cdtools/</code></para>
+	  <para>This directory contains the scripts used to build the
+	  ISO image and mirror.</para>
+	</listitem>
+
+	<listitem>
+	  <para><code>debian-np-install/</code></para>
+	  <para>This is where the Debian-NP installer, and
+	  customization of the Skolelinux installer work is
+	  done</para>
+	</listitem>
+	
+      </itemizedlist>
+
+    </sect2>
+
+  </sect2>
+
+  </sect1>
+
+</appendix>
+
+
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: xml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-namecase-general:t
+sgml-general-insert-case:lower
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-parent-document:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+sgml-indent-step:1
+sgml-indent-data:1
+sgml-set-face:t
+End:
+-->