This site has been retired. For up to date information, see handbook.gnome.org or gitlab.gnome.org.


[Home] [TitleIndex] [WordIndex

1. What's going on here?

Yelp has recently gained the ability to retry a search on a Web site. At the end of search results appears a link, "Repeat the search online at GNOME Support Forums". The text and target of this link can be customized easily by a distributor: for example, it might search help.ubuntu.com in Ubuntu, novell.com/support in Sled, or fedora.redhat.com/docs in Fedora. (The default is gnomesupport.org/forums only because Gnome has no help site or knowledge base of its own.)

The function is implemented in yelp-search-pager.c. More details in bug 344843.

2. What's needed on gnome.org?

A stable, never-breaking URL schema for these searches, that redirects to searching the Gnome support forums. Something like: http://api.gnome.org/help?q=can't+log+out

The URL needn't mention forums, because the function is about help in general, not forums in particular. And it needn't mention yelp, because it might also be used by some other help viewer (for example, a mini help viewer integrated into a program's window).

3. Why?

There are several reasons to make it easy for people to jump from a local search to a Web search when looking for help.

4. Possible future changes

Distributors are likely to add other parameters to the search, so it ends up something like http://help.example.com/search?q=can't+log+out&lang=en&version=2007. But because of the way the feature is implemented, these parameters don't need to be standardized or implemented at gnome.org.


2024-10-23 10:59