This is a first pass at restructuring the Install Guide.
HTML:
http://mythic-beasts.com/~hobb/fedora/fedora-install-guide-en/index.html
DocBook:
http://mythic-beasts.com/~hobb/fedora/fedora-install-guide-0.6.0.tar.gz
I've put in a chapter for post-installation, with some rough text that I wrote a while ago, basically so that we can direct the user's attention to Websites, particular tutorials or other bits of help and advice once they have completed the installation.
On Thu, 2005-04-07 at 01:10 +0100, Stuart Ellis wrote:
This is a first pass at restructuring the Install Guide.
HTML:
http://mythic-beasts.com/~hobb/fedora/fedora-install-guide-en/index.html
DocBook:
http://mythic-beasts.com/~hobb/fedora/fedora-install-guide-0.6.0.tar.gz
I've put in a chapter for post-installation, with some rough text that I wrote a while ago, basically so that we can direct the user's attention to Websites, particular tutorials or other bits of help and advice once they have completed the installation.
Yes, this post-install section is a good place to have links to all the external tutorials that no longer belong in the IG.
This is looking really good. I'm getting confident that we will have something relevant and useful for FC4 or thereabouts.
- Karsten
On Mon, 11 Apr 2005 11:46:23 -0700, "Karsten Wade" kwade@redhat.com said:
Yes, this post-install section is a good place to have links to all the external tutorials that no longer belong in the IG.
I intended it as a way of directing new users on to the on-line community as well, through the "Help on the Web" section. Unsure whether to put a more active "Partipate" or "Join the Community" piece in.
I also ought to note that Paul has checked in a Disk Partitioning section as well. This document is now pretty much out of the mire (fingers crossed).
--
Stuart Ellis
On Tue, 2005-04-12 at 10:29 +0100, Stuart Ellis wrote:
On Mon, 11 Apr 2005 11:46:23 -0700, "Karsten Wade" kwade@redhat.com said:
Yes, this post-install section is a good place to have links to all the external tutorials that no longer belong in the IG.
I intended it as a way of directing new users on to the on-line community as well, through the "Help on the Web" section. Unsure whether to put a more active "Partipate" or "Join the Community" piece in.
I also ought to note that Paul has checked in a Disk Partitioning section as well. This document is now pretty much out of the mire (fingers crossed).
Sorry if I held it up! :-( But it looks like we're back on schedule to possibly have a decent release for FC4, thanks to Stuart's tireless efforts. Do you know who has the bootloader section? I think that may be one of the only things left.
I am willing to start editing the portions I didn't write -- i.e. most of the guide -- for style if no one has any objections. Anyone else (who didn't write it) want to split it up with me? N.B. If you're not one of the "old hand" editors -- and I'm most definitely NOT including myself in that group -- you will probably want to visit the current Fedora Documentation Guide DRAFT style chapter, and make sure you are familiar with its content:
http://docs.frields.org/html/documentation-guide-en/
I was also thinking about whether it was worthwhile to change the name of this publication from a "guide" to a "handbook," based on its current mission to provide a lower level of instruction than the customary Red Hat Guides. Most of the existing Red Hat Guides are hundreds of pages, due to their extensive cross referencing and exhaustive discussion, whereas this guide will probably clock in at significantly less, due to its more practical tutorial format. Is this nitpicking, or does anyone else think there's value in differentiating between the two?
Perhaps it could start out this iteration as the "Installation Handbook" and, when there's enough material and community participation to warrant, it would become the "Installation Guide." Perhaps, on the other hand, I just need more coffee.
Hi
I was also thinking about whether it was worthwhile to change the name of this publication from a "guide" to a "handbook," based on its current mission to provide a lower level of instruction than the customary Red Hat Guides. Most of the existing Red Hat Guides are hundreds of pages, due to their extensive cross referencing and exhaustive discussion, whereas this guide will probably clock in at significantly less, due to its more practical tutorial format. Is this nitpicking, or does anyone else think there's value in differentiating between the two?
Considering the fact that FreeBSD handbook is larger than any of the Red Hat guides the difference in terminology looks just like nitpicking to me. End users just want the document regardless of whats its called.
regards Rahul
On Tue, 2005-04-12 at 17:51 +0530, Rahul Sundaram wrote:
Considering the fact that FreeBSD handbook is larger than any of the Red Hat guides the difference in terminology looks just like nitpicking to me. End users just want the document regardless of whats its called.
Glad you brought this up. The FreeBSD Handbook is a *great resource*. If Fedora Docs wants to have the best documentation a Linux distribution can ever have, the aim should be the style of The FreeBSD Handbook
Its just _amazing_
On Wed, 13 Apr 2005 01:58:10 +1000, "Colin Charles" byte@aeon.com.my said:
On Tue, 2005-04-12 at 17:51 +0530, Rahul Sundaram wrote:
Considering the fact that FreeBSD handbook is larger than any of the Red Hat guides the difference in terminology looks just like nitpicking to me. End users just want the document regardless of whats its called.
Glad you brought this up. The FreeBSD Handbook is a *great resource*. If Fedora Docs wants to have the best documentation a Linux distribution can ever have, the aim should be the style of The FreeBSD Handbook
Its just _amazing_
Definitely.
IMHO, though, it's hard to reproduce:
- Their release schedule is slower, which gives them a lot more time to check and revise the whole extent for each release.
- They assume a narrower target audience than we might be comfortable with.
- The sections also seem fairly tightly scoped. They extensively use callouts to man pages to supplement the material.
- I get the impression that they have a much smaller and more unified set of core software than we currently do.
- According to an interview with a FreeBSD documenter, the Handbook has about 15 active contributors, which must be quite hard to co-ordinate:
http://ezine.daemonnews.org/200408/trhodesinterview.html --
Stuart Ellis
On Tue, 12 Apr 2005 08:17:42 -0400, "Paul W. Frields" stickster@gmail.com said:
Sorry if I held it up! :-( But it looks like we're back on schedule to possibly have a decent release for FC4, thanks to Stuart's tireless efforts.
Well, I *was* tirelessly going in the wrong direction :), and really should have figured out much sooner that I was expecting the near impossible. So I'll happily take any brickbats...
Do you know who has the bootloader section? I think that may be one of the only things left.
Mayank (Sharma) sent me an initial draft, and I'll ping him.
I was also thinking about whether it was worthwhile to change the name of this publication from a "guide" to a "handbook," based on its current mission to provide a lower level of instruction than the customary Red Hat Guides. Is this nitpicking, or does anyone else think there's value in differentiating between the two?
Yes, I think that we should define what sort of document we want this project to produce (per separate thread on the FAQ, and not competing with other projects). IIRC, there's a bit of a precedent for Enterprise and Fedora using different terms to distinguish between the slightly different deliverables (bug fixes vs. errata). --
Stuart Ellis