[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: created software raid howto for debian systems



On Mon, 12 Jan 2004 18:41:42 -0700 (MST), Lucas Albers
<albersl@cs.montana.edu> posted to debian-doc:
 > http://www.cs.montana.edu/faq/faqw.admin.py?query=mdadm&querytype=simple&casefold=yes&req=search

The above URL provides a simple facility for making changes, but one
needs a password. Is this something you encourage? Wouldn't it be
better to move the whole thing to a public CVS (say, on Alioth)?

I tried to make some changes but obviously didn't have the required
password.

Here are some suggestions:

 * Add a TODO section where you summarize things which still need to
   be done.

 * You refer to the sfdisk command which isn't standard; you should
   list prerequisites (i.e. the util-linux package, and perhaps
   others?) in the "Getting Started" section.

 * Break things up into hierarchical sections. What to do before, what
   to do during the upgrade, what to do after. Within those sections,
   further break up each step unless it's entirely trivial.

 * The HTML formatting needs a thorough overhaul. If you move the
   source to DocBook or DebianDoc, the formatting tools will take care
   of that for you, of course. In particular, the formatting of
   commands is IMHO a bit confusing and unclear. Fixed-width type is
   pretty much the standard when quoting command lines. Also subheads,
   indentation levels etc. (which would follow from the previous
   suggestion) could help make the document easier to read.

 * s/easier then/easier than/

 * s%dev/had%dev/hda%

 * Punctuation and paragraph divisions are somewhat erratic in places,
   but perhaps you should work on the overall layout -- and perhaps
   choose a more author-friendly format -- before tackling these
   details.

Hope this helps,

/* era */

-- 
formail -s procmail <http://www.iki.fi/era/spam/ >http://www.euro.cauce.org/
cat | more | cat<http://www.iki.fi/era/unix/award.html>http://www.debian.org/



Reply to: