Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 04 Feb 2014 10:10:12 +0100
From:      =?ISO-8859-1?Q?G=E1bor_K=F6vesd=E1n?= <gabor@kovesdan.org>
To:        Warren Block <wblock@wonkity.com>
Cc:        Dru Lavigne <dru@freebsd.org>, "freebsd-doc@freebsd.org" <freebsd-doc@freebsd.org>
Subject:   Re: updating documentation set
Message-ID:  <52F0AE74.4090502@kovesdan.org>
In-Reply-To: <alpine.BSF.2.00.1402031956320.31566@wonkity.com>
References:  <1391476740.64494.YahooMailNeo@web184904.mail.gq1.yahoo.com> <alpine.BSF.2.00.1402031956320.31566@wonkity.com>

index | next in thread | previous in thread | raw e-mail

On 2014.02.04. 4:01, Warren Block wrote:
> On Mon, 3 Feb 2014, Dru Lavigne wrote:
>
>> This section:
>>
>> 23.4. Updating the Documentation Set
>>
>> really belongs (and is already mostly duplicated in):
>>
>> http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview.html#overview-doc 
>>
>>
>> Any objections to me doing the following?
>>
>> 1. remove "23.4. Updating the Documentation Set" from the Handbook, 
>> replacing it with a NOTE in the updating section that docs can either 
>> be updated during an OS upgrade or, at any other time, by following 
>> the instructions in the FDP overview (with link)
>>
>>
>> 2. make sure that any points covered by 23.4 and currently missing 
>> from the FDP overview are added to the FDP overview
>
> Don't we have doc ports specifically for users to keep a current 
> version of the documentation on their system?  Upgrading a port is 
> simpler for an end user than an svn checkout, there's less overhead, 
> and we would not have to expose them to developer instructions. 
I also think that should be still documented in the Handbook. It is a 
relevant information from an end-user perspective how to obtain the 
already rendered versions of other kind of documentation. And imo, it 
should be treated in the introduction or somewhere in the beginning.

Gabor


home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?52F0AE74.4090502>