[RFC] A Handbook Section on Updating the Documentation Set

[Giorgos Keramidas]

On Sat, 27 Dec 2008 23:43:20 +0100, Gabor PALI <pgj at FreeBSD.org> wrote:
>Giorgos Keramidas wrote:
>> It is a good idea to avoid using a specific CVSup server in the docs,
>> because users will tend to copy/paste the name of the server and
>> won't necessarily bother picking the right one for their setup.  On
>> the other hand, having examples that one can copy and paste is nice
>> too; it avoids the need for a lengthy explanation of what
>> cvsup"N"."country" means, and we have servers that don't match the
>> country-based pattern.
>
> - I assumed that readers are able to replace cvsup with csup and pick
> a server for themselves, so there is no more explanation needed.

Yes, that makes sense.

>> If we change to a <replaceable> template name, then we should update
>> the text before the commands too, and we should add a link to the
>> Handbook section that lists the CVSup servers.  A pointer to:
>>
>>     <link linkend="cvsup-mirrors">the list of CVSup mirrors</link>
>>
>> should suffice for that.
>
> Yep, we can add it.

Excellent.  I'm off to bed, so I trust whatever you guys decide about
the hostname vs. replaceable should be fine :)