[LWN Logo]
[LWN.net]
From:	 Dan York <dyork@e-smith.com>
To:	 lwn@lwn.net
Subject: e-smith documentation update
Date:	 Tue, 29 May 2001 11:51:21 -0400

Something else for your distribution page...... thanks.


========================================================
e-smith Documentation Update
========================================================

Date:  May 28, 2001

Contents:

  - Updated user manual
  - HOWTO documents
  - HOWTO template
  - Documentation mailing list
  - The e-smith documentation process explained


UPDATED USER MANUAL
-------------------
FYI, we recently made some minor updates to the e-smith version 4.1
user manual.  The manual is available in multiple formats (HTML,
PDF, DocBook SGML) at:

  http://www.e-smith.org/docs/manual

The manual, like most of the HOWTO documents created by e-smith, inc., is
licensed under the GNU Free Documentation License.


HOWTO DOCUMENTS
---------------
It's been a busy period of time on the submission of 
contributed HOWTO documents recently.  e-smith staff have 
written or updated two documents recently that can be found at:

  http://www.e-smith.org/docs/howto/
 
They are:

  - How to build an e-smith contrib module by Kirrily "Skud" Robert
  - How to install Network Information Services (NIS) on your 
      e-smith server and gateway, by Dan York

But the larger story is the many contributed HOWTO documents that
can be found at:

  http://www.e-smith.org/cgi-bin/contrib.cgi

Recent submissions include:

  - How to use PHPFormMail on e-smith 4.1.x, by Darrell May
  - How to increase the attachment file size limit in webmail,
       by Darrell May
  - How to install 3dm and 3ware 6400 card on your e-smith server in a RAID5
       configuration, by Eric Womack
  - How to install e-smith 4.1.2 on an ASUS A7V133 ATA100 board using the 
       Promise ATA100 controller with a single ATA100 drive, by Dan Turner
  - How to set up user authentication for the squid proxy server, 
       by Tim Litwiller
  - How to delete multiple users from e-smith 4.1.x, by Darrell May
  - How to use phpBB for web user forums, by Jason Hammond
  - French instructions on how to install e-smith server 4.0, by Hugues Michel

Many thanks to all those of those who contributed these documents.

Note that all of these documents are specific to the e-smith server and
gateway.  Generic Linux HOWTO documents can be found at the Linux
Documentation Project at http://www.linuxdoc.org/


DOCBOOK HOWTO TEMPLATE
----------------------
We accept contributed HOWTO documents in whatever form people can send them
to us.  The goal is that we need an HTML version that we can put on the web
site.  Ideally, we prefer to receive DocBook SGML as that is what we use 
internally and we can easily generate multiple formats from the DocBook 
source file.  In order to help with the creation of HOWTO documents, we have
made a template available from:

  http://www.e-smith.org/docs/template-howto.sgml


DOCUMENTATION MAILING LIST
--------------------------
A mailing list has been set up for all of those people interested in helping
out with e-smith documentation.  Please see:

  http://www.e-smith.org/docs/

for more information about to sign up for the list.


THE E-SMITH DOCUMENTATION PROCESS
---------------------------------
In response to queries, Dan York put together a document outlining the various
different tools we use to work with DocBook SGML in the process of developing
our documentation.  The document is available online at:

  http://www.e-smith.org/docs/docprocess.html


For more information about any of this, or if you have questions or feedback,
please contact 'documentation@e-smith.com'

-- 
Dan York, Director of Training        dyork@e-smith.com
Ph: +1-613-751-4401  Mobile: +1-613-263-4312 Fax: +1-613-564-7739 
e-smith, inc. 150 Metcalfe St., Suite 1500, Ottawa,ON K2P 1P1 Canada
http://www.e-smith.com/            open source, open mind