Karsten Wade wrote:
On Wed, 2006-03-08 at 14:30 +0530, Rahul Sundaram wrote:
Hi
The network section on the release notes
(http://fedoraproject.org/wiki/Docs/Beats/Networking) documents some of
the major changes between kernel revisions but these are already nicely
documented at http://wiki.kernelnewbies.org/LinuxChanges. I added this
link to the relevant section already but maybe we should not duplicate
this information within the release notes unnecessarily?
It is an interesting question that dovetails into something that I was
thinking about this morning:
How online can we go with our release notes? How far _should_ we go?
On-system documentation is very valuable, that is, manual and info
pages. What role do the release notes play in on-system documentation?
Can/should they be useful in a non-network situation?
The release notes can give a location to list bugs fixed, bugs known,
and latest information that could not make it into package
documentation. Should it do that?
I strongly believe it should provide references to this information but
not include them within the release notes itself. We should provide a
list of bug reports fixed with equivalent bugzilla links. We should also
summarize and present major known issues and total bug count. Our build
system should do this along with the rawhide reports. As an example,
this is pretty useful - http://weblogs.mozillazine.org/rumblingedge/
A release notes is a snapshot in time of documentation that is about a
snapshot in time of code development. It seems to me a natural place to
duplicate all manner of external content that pertains to that snapshot.
Package change lists, bug reports, and content pulls from various
location can be automated.
Our release notes serve general end users primarily but developers and
more technical end users need to tap into and be able to analyze
detailed information where necessary.
--
Rahul
--
fedora-docs-list@xxxxxxxxxx
To unsubscribe:
https://www.redhat.com/mailman/listinfo/fedora-docs-list
