discuss: Guides page
Subject:
Re: Guides page
From:
"Joy E Yokley" ####@####.####
Date:
16 Feb 2001 16:22:36 -0000
Message-Id: <OFDBF2B48E.A6D62A35-ON852569F5.00572753@raleigh.ibm.com>
Joining in on the discussion of the shorter "quick reference" docs, I think
that these may deserve a place of their own. Although only two docs have
been identified at this time, this type of documentation may grow as the
number of users who are new to Linux grows. For example, this may be a
great place for documentation that appeals to users who have a less
technical background.
The definition of a Quick Reference doc: a quick, general topic, reference
material geared towards a less technical audience.
Both of the documents you mentioned below would fit into this category.
http://www.powerup.com.au/~squadron/ --was the only one page manual I
could find that the LDP referenced.
The "Linux Security Quick Reference Guide"
Aditionally, this type of documentation is an excellent handout at the LDP
booth (much like the "Linux Security Quick Reference Guide" popularity at
this year's NY LWE booth.)
A little premature but also worth considering is a new category called
"tutorial." (Of course there is no reason to put up a category with nothing
to go in it right now, but I think this is going to be one that begins to
populate.) Maybe even beginning with a DocBook tutorial. This type of
documentation supports the rest of the information in the LDP, but offers
something to users that the rest of the documentation does not.
Thanks,
joy
Joy E. Yokley
Linux Information Development
IBM Linux Technology Services
512-838-4118
David Merrill ####@####.#### on 02/16/2001 09:28:37 AM
To: ldp-discuss ####@####.####
cc:
Subject: Re: Guides page
On Fri, Feb 16, 2001 at 09:41:33AM -0500, Greg Ferguson wrote:
> On Feb 16, 7:55am, David Merrill wrote:
> > Subject: Re: Guides page
> > > > [...]
> > > > The RUTE Users Tutorial and Exposition v0.3 Last update March 2000
> > > > is on http://rute.sourceforge.net at version 0.8.5 and available
> > > > in many formats(html, pdf, ps)
> > [...]
> > This document isn't free even by the most generous standards. Take a
> > look at the license. I'm not following up on this; I'd rather see the
> > document pulled from the LDP. The license is just too restrictive for
> > me. For example, it would be a violation if I were to print a copy for
> > my mom - only the intended reader can initiate a hard copy. It cannot
> > be distributed publicly, so we couldn't give it out at LWE or another
> > conference.
>
> I agree. I believe the author was intending to remove the restrictions
> once the document was completed. It seems like the license has moved
> in the other direction. I have removed the document from the LDP.
> It does not belong when it contains such license restrictions.
>
> I had not heard from the author in quite some time.
Thank you.
I think I will write to the author and let him know we are removing
the document, and ask him to consider relicensing if he wants it in
the LDP.
The minimum standard for an LDP document should be that it is freely
redistributable for commercial and noncommercial use.
> On the subject of the "Linux Security Quick Reference Guide"...
> I changed the name to reflect the type of document: "Linux Security
> Quick Reference Card". Should it still move elsewhere? I think
> the guides area has become somewhat of a collect-all for those items
> that do not fit elsewhere (not a HOWTO/FAQ).
>
> I suppose we could add an extra area on the docs.html page for
> these types of documents, but I think it might make them harder
> to locate.
There is another document that is a quick reference to linux commands.
I think it is called the "One Page Linux Manual" or something like
that. I don't see it anywhere right now and don't have time to dig for
it. These two document probably belong together, wherever that might
be.
Sorry, I don't have a good answer for this. It's not a HOWTO, it's
most definitely not a guide. It's not worth a restructuring for a
couple of docs that don't fit, though. Let's just put it in the howto
section for now because that's better than guides, even if it's not
really right.
Eventually, I want to see us move away from the separation of
documents based on length. Someday I will go through the HOWTO-Index
and make sure all the various document types are listed together -
while designating them according to their type. I know when I'm
looking for help on a certain subject, I don't particularly care
whether the doc is a guide, howto, or whatever. I just care about the
subject matter.
I want to make clear the distinction that I don't want to stop
classifying documents according to type - and I don't think it's a
problem to have separate lists. I just want to also have an integrated
list.
--
Dr. David C. Merrill http://www.lupercalia.net
Linux Documentation Project ####@####.####
Collection Editor & Coordinator http://www.linuxdoc.org
Finger me for my public key
This login session: $13.99
_________________________
http://list.linuxdoc.org/
