Package:fai
Version: 2.8.2
Severity: wishlist

When looking at the fai documentation in the fai-guide, I believe that the 
Placement of the Qickstart Chapter "For the impatient user" as
subchapter 9 of Chapter 4 "Overview of the installation sequence" is not
optimal. Real impatient users won't read until 4.9 and might not search 
under the name of chapter 4 for Quickstart docs. I therefore propose to 
move 4.9 to the last subchapter of chapter 1 and add the word Quickstart in
the name so we have "Quickstart - for the impatient user".

Patch included.




diff -Nur fai-2.8.2-unchanged/doc/fai-guide.sgml fai-2.8.2_doc-patch_move-quickstart/doc/fai-guide.sgml
--- fai-2.8.2-unchanged/doc/fai-guide.sgml	2005-04-29 11:33:46.000000000 +0200
+++ fai-2.8.2_doc-patch_move-quickstart/doc/fai-guide.sgml	2005-05-14 12:29:01.000000000 +0200
@@ -240,6 +240,34 @@
 	    <item> <p>Automatic hardware detection</p> </item>
 </list>
 
+<sect id=impatient>Quickstart - For the impatient user<p>
+
+So, you do not like to read the whole manual? You like to try an
+installation without reading the manual? OK. Here's how to succeed in
+a few minutes.
+
+<list>
+   <item><p>Install fai and all recommended packages (see
+<ref id="faisetup"> on your install server).</p></item>
+
+<item><p>
+Install the simple examples into the configuration space:
+<p><tt>cp -a /usr/share/doc/fai/examples/simple/* /usr/local/share/fai/</tt>
+</p></item>
+
+<item><p>Get the MAC address of your demo host.</p></item>
+  <item><p>Add your host (try to name it <tt>demohost</tt>)
+  to <file>/etc/hosts</file> and <file>dhcpd.conf</file>.</p></item>
+<item><p>When using PXE, tell the install client to boot the install
+  kernel and perform an installation during the next boot <example>fai-chboot -IFv demohost</example>
+</p></item>
+<item><p>Boot your demo host and enjoy the fully automatic installation.</p></item>
+<item><p>If the installation has finished successfully, the computer should boot a
+small Debian system. You can login as user <tt>demo</tt> with password <tt>fai</tt>.</p></item>
+
+</list>
+But now don't forget to read the chapter <ref id="plan">!
+
 <chapt id="inst">Installing FAI
 <sect id="requirements">Requirements<p> 
 
@@ -1190,34 +1218,6 @@
 the installation would be performed again. Read <ref id="changeboot">
 for how to change the boot device.
 
-<sect id=impatient>For the impatient user<p>
-
-So, you do not like to read the whole manual? You like to try an
-installation without reading the manual? OK. Here's how to succeed in
-a few minutes.
-
-<list>
-   <item><p>Install fai and all recommended packages (see
-<ref id="faisetup"> on your install server).</p></item>
-
-<item><p>
-Install the simple examples into the configuration space:
-<p><tt>cp -a /usr/share/doc/fai/examples/simple/* /usr/local/share/fai/</tt>
-</p></item>
-
-<item><p>Get the MAC address of your demo host.</p></item>
-  <item><p>Add your host (try to name it <tt>demohost</tt>)
-  to <file>/etc/hosts</file> and <file>dhcpd.conf</file>.</p></item>
-<item><p>When using PXE, tell the install client to boot the install
-  kernel and perform an installation during the next boot <example>fai-chboot -IFv demohost</example>
-</p></item>
-<item><p>Boot your demo host and enjoy the fully automatic installation.</p></item>
-<item><p>If the installation has finished successfully, the computer should boot a
-small Debian system. You can login as user <tt>demo</tt> with password <tt>fai</tt>.</p></item>
-
-</list>
-But now don't forget to read the next chapter <ref id="plan">!
-
 <chapt id=plan>Plan your installation, and FAI installs your plans<p>
 <p>
 Before starting your installation, you should spend much time in

Reply via email to