[RFC] Legacy documentation

Stuart Ellis s.ellis at fastmail.co.uk
Fri Apr 8 09:34:13 UTC 2005


On Tue, 05 Apr 2005 17:49:08 -0700, "Karsten Wade" <kwade at redhat.com>
said:

"We have a few documents that are FC2 specific and are going to be
orphaned when FC2 moves over to the Legacy Project.  The Docs Project
(FDP) follows the Fedora Core release and maintenance schedule, meaning
when a version of Core goes to the Legacy Project, the docs should go
with it."

Two questions and one suggestion:

- Do people think it's useful/feasible to specify which versions of
Fedora a document pertains to within the document, or not ?

- What should happen when the version of Fedora Core is no longer
supported by Legacy ?  At some point copies of a document will be still
in circulation with no support at all.

- When a document transfers to Legacy status, it might be worth sticking
a boiler-plate bit of text at the top, just as we do with draft
documentation.  Perhaps something like one of these:


"LEGACY DOCUMENT

This document relates a version of Fedora Core that is no longer
supported by the Fedora Project.  Changes in later version of Fedora
Core may have made the information in this document inaccurate.  Please
check the Documentation Website at http://fedora.redhat.com/docs/ for a
current version before carrying out any of the instructions in this
document on your system.

This version of the document will not be changed or amended, except to
correct errors that may result in data loss or a weakening of system
security.  If you beleive that you have found such an error, please
report it vis Bugzilla in bug ###."

"OBSOLETE

This document relates a version of Fedora Core that is no longer
supported.  Changes in later version of Fedora Core may have made the
information presented in this document inaccurate.  Please check the
Documentation Website at http://fedora.redhat.com/docs/ for a current
version before carrying out any of the instructions in this document on
your system.

No further updates or amendments to this version of the document will be
made."
--

Stuart Ellis




More information about the fedora-docs-list mailing list