[CentOS-docs] Added BackupPC Guide

Ned Slider

ned at unixmail.co.uk
Fri Dec 19 14:48:49 UTC 2008

Ralph Angenendt wrote:
> Ned Slider wrote:
>> In hind sight, that's probably not the clearest way to do it and 
>> formatting it in a separate note box would probably make it stand out more.
> Probably. Or have two config sections (one for x86_64, one for i386) so
> people can still cut and paste.

Yes, I like that idea :)

>> Equally, where config stuff has changed between dists (eg, C4 > C5), 
>> I've stated the guide was written for C5 but added notes affecting C4 
>> where I've known of differences (for example, 
>> HowTos/postfix_restrictions where some of the config syntax changed 
>> between postfix versions).
> Yes. Or write it twice or three times, for 4 and 5 (or maybe even 3).
> This has been done on several pages, see the HardwareList. If it really
> is release specific (meaning it really is only for 5 or for 4), this
> should be stated directly at the top of the document ...

Or as per your idea above - have separate C4 and C5 config sections.

>> WRT your point above, IMHO major information (potential show stoppers) 
>> such as dist or arch specific notes would probably be best included in a 
>> note at the *top* of the document rather than the bottom. I'd be a 
>> little miffed at reading a whole document only to discover right at the 
>> bottom of the page that there is an arch or dist gotcha that applies to 
>> me. 
> ... to avoid exactly that >:)
> What could be done and means a bit of work: Work with categories on the
> wiki pages. 
> So you could have a Category64Bit, Category32Bit, CategoryCentOS5,
> CategoryCentOS4 at the bottom of each page. We could then create
> overview pages for CentOS 4, CentOS 5, x86_64 (and so on) on which these
> articles will automatically be listed.

Also involving some work, if needed I had envisaged maybe adding a 
standard header section to the top of each article. Something like this 
to give an idea:

Title:		Foo on CentOS
Author(s):	name/email
Maintainer(s):	name/email
Dist:		Written and tested on C5, should work on C4
Arch:		Tested on x86, should work on X86_64 (see notes)
Summary:	This guide is to install and configure foo on CentOS. It is not 
intended to cover bar or blah.

which also involves some work retrofitting but could be added to 
templates for new articles.

Your solution looks more technically adept :)

More information about the CentOS-docs mailing list