doc/source/developer-manual.sgml

   1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
   2 <!--
   3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
   4  File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/faq.html,v $
   5
   6  Purpose     :  FAQ
   7                 This file belongs into
   8                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
   9
  10  $Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $
  11
  12  Written by and Copyright (C) 2001 the SourceForge
  13  IJBSWA team.  http://ijbswa.sourceforge.net
  14
  15  Based on the Internet Junkbuster originally written
  16  by and Copyright (C) 1997 Anonymous Coders and
  17  Junkbusters Corporation.  http://www.junkbusters.com
  18 -->
  19
  20 <article id="index">
  21 <artheader>
  22 <title>Junkbuster Developer Manual</title>
  23
  24 <pubdate>$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $</pubdate>
  25
  26 <authorgroup>
  27  <author>
  28   <affiliation>
  29    <orgname>By: Junkbuster Developers</orgname>
  30    </affiliation>
  31  </author>
  32 </authorgroup>
  33
  34 <abstract>
  35  <para>
  36     The developer manual gives the users information on how to help the developer
  37 team. It provides guidance on coding, testing, documentation and other
  38 issues. The Internet Junkbuster is an application
  39 that provides privacy and security to the user of the world wide web.
  40  </para>
  41  <para>
  42 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/doc/developer-manual/">http://ijbswa.sourceforge.net/doc/developer-manual/</ulink>.
  43  </para>
  44
  45  <para>
  46   Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
  47  </para>
  48 </abstract>
  49 </artheader>
  50
  51 <!--   ~~~~~       New section      ~~~~~     -->
  52 <sect1 id="introduction"><title>Introduction</title>
  53 <para>To be filled.
  54 </para>
  55 </sect1>
  56
  57 <!--   ~~~~~       New section      ~~~~~     -->
  58 <sect1 id="quickstart"><title>Quickstart to Junkbuster Development</title>
  59 <para>To be filled.
  60 </para>
  61 </sect1>
  62
  63 <!--   ~~~~~       New section      ~~~~~     -->
  64 <sect1 id="documentation"><title>Documentation Guidelines</title>
  65 <para>
  66 All docs should be ...
  67 <ItemizedList>
  68   <ListItem>in a format that is widely used. I propose HTML.</ListItem>
  69   <ListItem>we either
  70       <ItemizedList>
  71         <ListItem>generate man pages from the documentation (let's _NOT_ write them manually), or </ListItem>
  72         <ListItem>we have a man page that points to the documentation (I propose</ListItem>
  73             this option)
  74       </ItemizedList></ListItem>
  75   <ListItem>have a consistent layout</ListItem>
  76   <ListItem>have a link to the latest version of the document (i.e. point to a URL at sf)</ListItem>
  77   <ListItem>be consistent with the redirect script (i.e. the junkbuster program
  78       points via the redirect URL at sf to valid end-points in the document)</ListItem>
  79   <ListItem>started from scratch but recycle parts from the original junkbuster documents</ListItem>
  80 </ItemizedList>
  81 </para>
  82 </sect1>
  83
  84 <!--   ~~~~~       New section      ~~~~~     -->
  85 <sect1 id="coding"><title>Coding Guidelines</title>
  86 <para>To be filled.
  87 </para>
  88 </sect1>
  89
  90 <!--   ~~~~~       New section      ~~~~~     -->
  91 <sect1 id="testing"><title>Testing Guidelines</title>
  92 <para>To be filled.
  93 </para>
  94
  95 <!--   ~~~~~       New section      ~~~~~     -->
  96 <sect2 id="testing-plan"><title>Testplan for releases</title>
  97 <para>
  98 <OrderedList Numeration="Arabic">
  99   <ListItem>
 100 Remove any existing rpm with rpm -e
 101 </ListItem>
 102   <ListItem>
 103 Remove any file that was left over. This includes (but is not limited to)
 104       <ItemizedList>
 105         <ListItem>/var/log/junkbuster</ListItem>
 106         <ListItem>/etc/junkbuster</ListItem>
 107         <ListItem>/usr/sbin/junkbuster</ListItem>
 108         <ListItem>/etc/init.d/junkbuster</ListItem>
 109         <ListItem>/usr/doc/junkbuster*</ListItem>
 110       </ItemizedList>
 111 </ListItem>
 112 <ListItem>
 113 Install the rpm. Any error messages?
 114 </ListItem>
 115   <ListItem>start,stop,status junkbuster with the specific script
 116       (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
 117       autostart work?</ListItem>
 118   <ListItem>Start browsing. Does the junkbuster work? Logfile written?</ListItem>
 119   <ListItem>Remove the rpm. Any error messages? All files removed?</ListItem>
 120 </OrderedList>
 121 </para>
 122 </sect2>
 123
 124 <!--   ~~~~~       New section      ~~~~~     -->
 125 <sect2 id="testing-report"><title>Test reports</title>
 126 <para>
 127 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
 128 at sourceforge. Three simple steps:
 129 <ItemizedList>
 130   <ListItem>Select category: the distribution you test on.</ListItem>
 131   <ListItem>Select group: the version of Junkbuster that we are about to release.</ListItem>
 132   <ListItem>Fill the Summary and Detailed Description with something intelligent (keep it short and precise).</ListItem>
 133 </ItemizedList>
 134 Do not mail to the mailinglist (we cannot keep track on issues there).
 135 </para>
 136 </sect2>
 137
 138 </sect1>
 139
 140 <!--   ~~~~~       New section      ~~~~~     -->
 141 <sect1 id="contact"><title>Contact the developers</title>
 142 <para>Please see the user manual for information on how to contact the developers.
 143 </para>
 144 </sect1>
 145
 146 <!--   ~~~~~       New section      ~~~~~     -->
 147 <sect1 id="copyright"><title>Copyright and History</title>
 148 <para>To be filled.
 149 </para>
 150 </sect1>
 151
 152 <!--   ~~~~~       New section      ~~~~~     -->
 153 <sect1 id="seealso"><title>See also</title>
 154 <para>To be filled.
 155 </para>
 156 </sect1>
 157
 158 <!-- hhmts end -->
 159  <!--
 160  Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
 161
 162  Last modified: Mon Sep 10 19:22:09 CEST 2001
 163
 164  This program is free software; you can redistribute it
 165  and/or modify it under the terms of the GNU General
 166  Public License as published by the Free Software
 167  Foundation; either version 2 of the License, or (at
 168  your option) any later version.
 169
 170  This program is distributed in the hope that it will
 171  be useful, but WITHOUT ANY WARRANTY; without even the
 172  implied warranty of MERCHANTABILITY or FITNESS FOR A
 173  PARTICULAR PURPOSE.  See the GNU General Public
 174  License for more details.
 175
 176  The GNU General Public License should be included with
 177  this file.  If not, you can view it at
 178  http://www.gnu.org/copyleft/gpl.html
 179  or write to the Free Software Foundation, Inc., 59
 180  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 181
 182 $Log: faq.html,v $
 183 Revision 1.3  2001/09/10 17:43:59  swa
 184 first proposal of a structure.
 185
 186 Revision 1.2  2001/06/13 14:28:31  swa
 187 docs should have an author.
 188
 189 Revision 1.1  2001/06/13 14:20:37  swa
 190 first import of project's documentation for the webserver.
 191
 192 -->
 193
 194 </article>