Test of Docs Packaging

[David Malcolm]

On Fri, 2005-10-14 at 15:41 -0500, Tommy Reynolds wrote:
> Uttered James Laska <jlaska at redhat.com>, spake thus:
> 
> > On Fri, 2005-10-14 at 12:58 -0500, Tommy Reynolds wrote:
> > > I don't envision the tarballs nor the RPM's to be used in the
> > > authoring process.  
> > Unfortunately, there is the interim phase where you must build the
> > package.  When that process is unfolding
> > (in /usr/src/redhat/BUILD/$docbase-$lang), the "../docs-common/"
> > directory structure will not map correctly.  Does that makes sense?
> 
> Not to me ;-{ 
> 
> Could someone (Paul?) please clarify who is supposed to be using
> what?  I confess to active avoidance of all things GUI, so I may not
> be clear on the purpose of these RPM's in association with YELP and all
> that.  Does it do the XML rendering on the fly, or something?  If
> not, why put XML in the RPM's at all?
> 
> I don't think we want any author to be mucking about with the RPM's
> and tarball's: authors should use CVS, period.  What I'm looking for
> is an explanation from the _end_ _user's_ point of view of how the
> RPM's will be used.

(I'm coming in late to this discussion, so my apologies if this has
already been covered)


Yelp can render DocBook XML "on the fly" (actually it converts it
internally to HTML with a heavily-optimised stylesheet, and renders it
using the Gtk embedded gecko widget).

Currently in rawhide if you click on Desktop->Help (or "Help Topics" in
Yelp) you don't get a very helpful list.

I'd love it if FC5 out of the box had a good contents page there, with
some initial description of what Fedora is, and how to get involved,
perhaps followed by top-level categories for end-user documentation, and
sysadmin documentation.  The various DocBook XML files could be hooked
in there somehow...

There's a bug to cover this here:
https://bugzilla.redhat.com/bugzilla/show_bug.cgi?id=170847


Would it be useful for this mailing list to come up with a scheme for
what ought to be displayed on the front page of Yelp, and we can take it
from there?


Dave