Log Message:
-----------
Add release checklist to documentation tree

Modified Files:
--------------
    slony1-engine/doc/adminguide:
        filelist.sgml (r1.17 -> r1.18)
        slony.sgml (r1.35 -> r1.36)

Added Files:
-----------
    slony1-engine/doc/adminguide:
        releasechecklist.sgml (r1.1)

-------------- next part --------------
--- /dev/null
+++ doc/adminguide/releasechecklist.sgml
@@ -0,0 +1,98 @@
+<!-- $Id: releasechecklist.sgml,v 1.1 2006/10/04 15:52:13 cbbrowne Exp $ -->
+<article id="releasechecklist"> <title> Release Checklist </title>
+
+<indexterm><primary>release checklist</primary></indexterm>
+
+<para> Here are things that should be done whenever a release is prepared:</para>
+<itemizedlist>
+
+  <listitem><para>Positive build reports for each supported platform -
+  although it is arguably less necessary for a comprehensive list if
+  we are releasing a minor upgrade
+
+  </para></listitem> 
+
+<listitem><para>Some kind of Standard Test Plan 
+
+  </para></listitem> 
+<listitem><para>Binary RPM packages 
+
+  </para></listitem> 
+<listitem><para>Tag with the release ID. For version 1.1.2, this would be <envar>REL_1_1_2 </envar>
+
+  </para></listitem> 
+<listitem><para>Check out a copy via <command>cvs export -rREL_1_1_2 </command>
+
+  </para></listitem> 
+
+<listitem><para>Run <application>autoconf</application> so as to
+regenerate <filename>configure</filename> from
+<filename>configure.ac</filename>
+
+  </para></listitem> 
+<listitem><para>Purge directory <filename>autom4te.cache</filename> so it is not included in the build 
+
+  </para></listitem> 
+<listitem><para>Need to make sure that all references to CVS tags properly point to the tag for the release. 
+
+<para>For instance, configure should contain, for release 1.1.2:
+<itemizedlist>
+<listitem><para>PACKAGE_VERSION=REL_1_1_2</para></listitem>
+
+<listitem><para>PACKAGE_STRING=postgresql-slony1-engine REL_1_1_2</para></listitem>
+</itemizedlist>
+
+<para> RPM spec files used to contain release tags as well as names of tarballs which needed to be updated. As of 2005-12-13, there is less of this...   For those platforms with specific spec files such as SuSE, some editing still needs to be done. see the file(s) in the <filename>suse</filename> dir for more information 
+
+<para> The admin guide <filename>version.sgml</filename> file needs to contain the release name. This should not need to be touched; version.sgml is generated automatically with the release name/tag on demand. </para>
+
+<para> It sure would be nice if more of these could be assigned automatically, somehow.
+
+</para></listitem> 
+<listitem><para>commit the new configure 
+
+  </para></listitem> 
+
+<listitem><para>make sure that the generated files from .l and .y are
+created, for example <filename>slony/conf-file.[ch]</filename> </para>
+
+<para> Currently this is best done by issuing <command> ./configure &&
+make all && make clean</command> but that is a somewhat ugly approach.
+
+</para></listitem> 
+<listitem><para>Generate HTML tarball, and RTF/PDF, if possible... Note that the HTML version should include *.html (duh!), *.jpg, *.png, as well as *.css 
+  </para></listitem> 
+
+<listitem><para>Run <command>make clean</command> in <filename>doc/adminguide</filename> before generating the tarball in order that <filename>bookindex.sgml</filename> is NOT part of the tarball 
+
+  </para></listitem> 
+<listitem><para>Alternatively, delete <filename>doc/adminguide/bookindex.sgml </filename>
+
+  </para></listitem> 
+<listitem><para>Rename the directory (e.g <filename>slony1-engine</filename>) to a name based on the release, e.g. - <filename>slony1-1.1.2 </filename>
+
+  </para></listitem> 
+<listitem><para>Generate a tarball - <command>tar tfvj slony1-1.1.2.tar.bz2 slony1-1.1.2 </command>
+
+  </para></listitem> 
+<listitem><para>Build the administrative documentation, and build a tarball as <filename>slony1-1.1.2-html.tar.bz2</filename> <para> Make sure that the docs are inside a subdir in the tarball.
+
+</para></listitem> 
+<listitem><para>Put these tarballs in a temporary area, and notify everyone (on some mailing list???) that they should test them out ASAP based on the Standard Test Plan. 
+</para></listitem></itemizedlist>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode:sgml
+sgml-omittag:nil
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:"slony.sgml"
+sgml-exposed-tags:nil
+sgml-local-catalogs:("/usr/lib/sgml/catalog")
+sgml-local-ecat-files:nil
+End:
+-->
Index: slony.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/slony.sgml,v
retrieving revision 1.35
retrieving revision 1.36
diff -Ldoc/adminguide/slony.sgml -Ldoc/adminguide/slony.sgml -u -w -r1.35 -r1.36
--- doc/adminguide/slony.sgml
+++ doc/adminguide/slony.sgml
@@ -133,6 +133,7 @@
 </part>
 
 &supportedplatforms;
+&releasechecklist;
 &schemadoc;
 &bookindex;
 
Index: filelist.sgml
===================================================================
RCS file: /usr/local/cvsroot/slony1/slony1-engine/doc/adminguide/filelist.sgml,v
retrieving revision 1.17
retrieving revision 1.18
diff -Ldoc/adminguide/filelist.sgml -Ldoc/adminguide/filelist.sgml -u -w -r1.17 -r1.18
--- doc/adminguide/filelist.sgml
+++ doc/adminguide/filelist.sgml
@@ -43,6 +43,7 @@
 <!entity testbed            SYSTEM "testbed.sgml">
 <!entity loganalysis        SYSTEM "loganalysis.sgml">
 <!entity slonyupgrade       SYSTEM "slonyupgrade.sgml">
+<!entity releasechecklist   SYSTEM "releasechecklist.sgml">
 
 <!-- back matter -->
 <!entity biblio     SYSTEM "biblio.sgml">