[doc] Re: Documentation reccomendations

[Brent J. Nordquist]

On Wed, 7 Feb 2001, Chuck Hagenbuch <chuck@horde.org> wrote:

> Yeah... the other question is, are we going to keep INSTALL as
> comprehensive as it's currently trying to be? RedHat instructions are
> all well and good, but...

I've been trying to shunt all the Red Hat (RPM) specific stuff into the
RPM README file; I think that is the best general philosophy:  write for
tarballs and config. files (in as platform-non-specific a way as we can)
and put packaging stuff and OS-specific stuff elsewhere.

The 2.2 branch docs/INSTALL files do this.  I can't vouch for the 2.3 ones
because I've hardly touched them... I suspect they're a mess and I'm
frankly afraid to look hard.  ;-)

-- 
Brent J. Nordquist <bjn@horde.org>
Yahoo!: Brent_Nordquist / AIM: BrentJNordquist / ICQ: 76158942



>From chuck@horde.org Date: Wed,  7 Feb 2001 16:05:10 -0500
Return-Path: <chuck@horde.org>
Mailing-List: contact doc-help@lists.horde.org; run by ezmlm
Delivered-To: mailing list doc@lists.horde.org
Received: (qmail 67770 invoked from network); 7 Feb 2001 21:06:04 -0000
Received: from r94aag005136.sbo-smr.ma.cable.rcn.com (HELO marina.horde.org) (209.6.192.126)
  by horde.org with SMTP; 7 Feb 2001 21:06:04 -0000
Received: by marina.horde.org (Postfix, from userid 33)
	id 54F6F39F4; Wed,  7 Feb 2001 16:05:10 -0500 (EST)
Received: from 206.243.191.252 ( [206.243.191.252])
	as user chuck@marina by marina.horde.org with HTTP;
	Wed,  7 Feb 2001 16:05:10 -0500
Message-ID: <981579910.3a81b8863ad12@marina.horde.org>
Date: Wed,  7 Feb 2001 16:05:10 -0500
From: Chuck Hagenbuch <chuck@horde.org>
To: doc@lists.horde.org
MIME-Version: 1.0
Content-Type: text/plain
Content-Transfer-Encoding: 8bit
User-Agent: Internet Messaging Program (IMP) 2.3.7-cvs
Subject: Re: [doc] Re: Documentation reccomendations

Quoting "Brent J. Nordquist" <bjn@horde.org>:

> I've been trying to shunt all the Red Hat (RPM) specific stuff into the
> RPM README file; I think that is the best general philosophy:  write for
> tarballs and config. files (in as platform-non-specific a way as we can)
> and put packaging stuff and OS-specific stuff elsewhere.

I like this approach.

> The 2.2 branch docs/INSTALL files do this.  I can't vouch for the 2.3 ones
> because I've hardly touched them... I suspect they're a mess and I'm
> frankly afraid to look hard.  ;-)

Heh. Because of what you think you'll find, or what you think you _won't_ find? 
=)

-chuck

--
Charles Hagenbuch, <chuck@horde.org>
"My intuitive grasp of math often leads me astray." -Me


>From lordscarlet@idledreams.net Date: Wed,  7 Feb 2001 16:11:59 -0500
Return-Path: <lordscarlet@idledreams.net>
Mailing-List: contact doc-help@lists.horde.org; run by ezmlm
Delivered-To: mailing list doc@lists.horde.org
Received: (qmail 69756 invoked from network); 7 Feb 2001 21:12:02 -0000
Received: from cj130832-a.dlcty1.va.home.com (HELO firewall.idledreams.net) (root@24.7.175.36)
  by horde.org with SMTP; 7 Feb 2001 21:12:02 -0000
Received: (from nobody@localhost)
	by firewall.idledreams.net (8.11.0/8.11.0) id f17LC0X06367
	for doc@lists.horde.org; Wed, 7 Feb 2001 16:12:00 -0500
From: lordscarlet@idledreams.net
X-Authentication-Warning: firewall.idledreams.net: nobody set sender to lordscarlet@idledreams.net using -f
Received: from 206.161.94.18 ( [206.161.94.18])
	as user lordscarlet@mail.idledreams.net by mail.idledreams.net with HTTP;
	Wed,  7 Feb 2001 16:11:59 -0500
Message-ID: <981580319.3a81ba1f9eb2f@mail.idledreams.net>
Date: Wed,  7 Feb 2001 16:11:59 -0500
To: doc@lists.horde.org
References: <981579910.3a81b8863ad12@marina.horde.org>
In-Reply-To: <981579910.3a81b8863ad12@marina.horde.org>
MIME-Version: 1.0
Content-Type: text/plain
Content-Transfer-Encoding: 8bit
User-Agent: Internet Messaging Program (IMP) 2.3.7-cvs
Subject: Re: [doc] Re: Documentation reccomendations

Quoting Chuck Hagenbuch <chuck@horde.org>:

> Quoting "Brent J. Nordquist" <bjn@horde.org>:
> 
> > I've been trying to shunt all the Red Hat (RPM) specific stuff into the
> > RPM README file; I think that is the best general philosophy:  write for
> > tarballs and config. files (in as platform-non-specific a way as we can)
> > and put packaging stuff and OS-specific stuff elsewhere.
> 
> I like this approach.
> 
> > The 2.2 branch docs/INSTALL files do this.  I can't vouch for the 2.3
> ones
> > because I've hardly touched them... I suspect they're a mess and I'm
> > frankly afraid to look hard.  ;-)
> 
> Heh. Because of what you think you'll find, or what you think you _won't_
> find? 
> =)
> 
> -chuck

i'd be happy to be a guinea pig for going through the documentation word for 
word.. i have a second machine that is behind my firewall that doesn't do any 
server tasks so i'd be happy to screw it up in the process of trying.. and this 
time through i'll keep documentation of anything missing or wierd that 
happens :)

doug.