GNOME Bugzilla – Bug 348265
beagle-settings help button
Last modified: 2006-07-24 13:40:43 UTC
The help button brings up firefox trying to load a nonexisting page. There are three possible fixes here, in order from least desirable to most desirable: 1) Remove the help button 2) Write that web page 3) Add the docs in yelp and start yelp
Yeah, we have been considering Yelp on and off for a while now, but it just doesn't seem worth the effort of converting our docs from the wiki. Once library.gnome.org is up, I would expect we might move at least some of it there. But yeah, I updated it to point to a relevant webpage. http://cvs.gnome.org/bonsai/cvsquery.cgi?branch=&dir=beagle&who=kkubasik&date=explicit&mindate=2006-07-22%2012:14&maxdate=2006-07-22%2012:16 if your interested ;). Also feel free to add more information to that page!
If you are serious about getting beagle accepted in Gnome, providing docs in the Gnome help browser should not be considered "not worth the effort".
I'm not saying overall, I mean, in the short term there are a lot of other things to be done. I'm not discounting the importance of documentation in the slightest. But since we have lots of readily available documentation in the Wiki, it doesn't seem worth the redundant effort to move that all over to docbook at the moment. But considering that there is a new gnome-doc system under development, it seems highly likely (to me at least) that once that change has been made, and the online collaborative system set up, we would be far more inclined to port our documentation over to Yelp. (We like yelp here :) we do provide their search, and I have started making our module gnome-doc-utils compliant twice, but its difficult, and now with the SCM migration, it would make even less sense.)
Of course, online documentation (weather beagle wiki or library.gnome.org) always bears the obvious question - what if there's no network ?
That it does, but we do have some man pages, and _do_ eventualy plan to get working with yelp. But at the moment, that requires us to port a _lot_ of material from wiki-->docbook. Not a super-easy task, since all the documentation is already written (it really just needs formatting, I already have a patch to make beagle use gnome-doc-utils) feel free to tackle this yourself, if not, you might have to wait for a later release. Or (even better) if you can find me a xhtml->docbook converter, or a GUI for composing docbook, I would be just as happy.