Adding boilerplate errata/CVS instructions

[David Malcolm]

On Wed, 2004-11-17 at 16:39 -0800, Karsten Wade wrote:
> On Wed, 2004-11-17 at 13:59, David Malcolm wrote:
> > Attached is a file that supplies boilerplate instructions for reporting
> > errors/patches with a document.
> 
> This is a stellar idea, thanks!
> 
> I suggest a few changes, new file attached.

Thanks!

> 
> * Added a <!-- comment --> explaining how to obtain and format the URL
> from bugzilla/

Good idea.

> 
> * Some fill-column because I can't help myself. :)

Fair enough.

> 
> * Changed the <screen> code to match the current FDP style (flush left,
> <command> on same line, not in <para> block).

OK

> 
> > I propose adding the first file as "fedora-docs/common/errata-en.xml"
> 
> Recommend an RFE bug report.

Done, as this one:
https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=139931

Should this go on a tracker bug somewhere?

> 
> Might also want to patch fedora-entities-en.xml to have it make the
> entity declaration:
> 
> <!ENTITY ERRATA-TIP-EN SYSTEM "errata-en.xml">

Would doing this require that any files using fedora-entities-en.xml
define the various entities referred to in errata-en.xml ? (and hence
break all the existing docs, until they get fixed?)

> 
> > Any thoughts/rewrites?  Perhaps the heading should read "About This
> > Document" instead?
> 
> Yes, that is more of an accurate title.  Changed that in the attachment.

Perhaps the file should have a different name; perhaps
"about-this-document-en.xml" ?

> 
> ________________________________________________________________________
> - Karsten
> -- 
> fedora-docs-list mailing list
> fedora-docs-list at redhat.com
> To unsubscribe: 
> http://www.redhat.com/mailman/listinfo/fedora-docs-list