Date: Sat, 2 Jun 2001 01:22:18 -0400 From: Randy Pratt <rpratt@ezwv.com> To: Nik Clayton <nik@freebsd.org> Cc: Murray Stokely <murray@freebsd.org>, freebsd-doc@freebsd.org Subject: Re: Illustrated Installation Guide Message-ID: <01060201221801.00368@k6-2.weeble.com> In-Reply-To: <20010531140239.A2713@catkin.nothing-going-on.org> References: <01053012311102.00379@k6-2.weeble.com> <20010531140239.A2713@catkin.nothing-going-on.org>
index | next in thread | previous in thread | raw e-mail
Sorry for the delay in responding (family obligations). On Thursday 31 May 2001 09:02, you wrote: > On Wed, May 30, 2001 at 12:31:11PM -0400, Randy Pratt wrote: > > I finished the first pass of the installation guide in sgml format. Since > > this is my first attempt, I'm sure there's still work that needs to be > > done (sgml and content). > > > > I've no objections to any adding/cutting/editing to make the documents > > better or more general. I'd like Nik to decide how to best proceed with > > handling the committing/revisions. I'm a little fuzzy on those details. > > Some bullet points as they occur. > > * <mantra>commit content changes and whitespace changes > separately</mantra> Yep. I understand the need to make it easy for translation teams. > * It's probably worth breaking this down in to chapter.sgml files before > import. No problem. I'll get to work on this shortly. > * If we can, I'd like to get as many of the .png images converted to > the .scr format instead as possible -- otherwise we'll be bloating > the repo with the PNG images unecessarily. I'm also going to review the actual need for images in some places, replacing them with plain text where possible. > * In the "Documentation" section, does it need to include the > documentation that's with the installer verbatim, or is it just > sufficient to show the user that it's there? Including it verbatim > adds to the work required to maintain this between releases. Not necessary at all. They'll be removed in the conversion to chapter.sgml. > * s/cdrom/CDROM/ everywhere Yep. If anyone spots any other things like this just let me know. > * I can't shake the nagging feeling that this should be in the > Handbook, maybe with a slight reorganisation. . . > > Bring chapters 1, 2, 3, 4, 5, 6 together as sections in a chapter, > "Before you install". > > Chapters 7 through 13 become sections in a "Carrying out the install" > chapter. > > Chapters 14 onwards become sections in a "Post-installation" chapter. > > Maybe. > > Or perhaps we need an "Installation" <part> in the Handbook (as we > have "Getting Started", "System Administration", "Network > Communications" and other parts) which this could be the content of. I'll give some thought to this and see if I can come up with something. Its good sgml practice too. > * There are a couple of mini mark-up nits, but nothing major. > > I don't think any of these should be considered 'show stoppers' though. Thanks. I'll reread the fdp-primer and get a refresher. Randy To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-doc" in the body of the messagehome | help
Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?01060201221801.00368>