Closed Bug 243549 Opened 21 years ago Closed 16 years ago

Link to Bugzilla Guide (or provide additional docs) instead of the former queryhelp.cgi

Categories

(Bugzilla :: Documentation, defect)

2.17.7
defect
Not set
normal

Tracking

()

RESOLVED WORKSFORME

People

(Reporter: gerv, Unassigned)

References

Details

As it says on the tin. We should remove queryhelp.cgi and link to the Bugzilla Guide instead, for a number of reasons - localisability, readability etc. This has been discussed on the developers mailing list. (See also bug 88788). Gerv
Blocks: 214907
Is the Bugzilla guide adequate for a beginner? I think we should have templated context help for quick answers for common questions with links to the Bugzilla Guide for more detailed information that would overwhelm most people. If you look at the User portion of the Bugzilla guide, it seems that this will cause the jaws to drop of people, and what will end up happening is they won't read anything. http://www.bugzilla.org/docs/html/using.html I believe a balanced mix of simple context help, along with links to more detailed portions of the Bugzilla guide would be something that would be a lot more user friendly.
> Is the Bugzilla guide adequate for a beginner? If it's not, then we need to fix it so that it is. The User part of the Bugzilla Guide should explain how to, er, use it. I don't think there's a trade-off between "quick question answers" and "overwhelming complexity", I think we should just knuckle down and write a decent manual. Obviously, we don't just link to the top-level page. So for searching, we'd link to (and flesh out) the local copy of http://www.bugzilla.org/docs/html/query.html . Gerv
The Bugzilla Guide isn't exactly localizable the way we have it set up currently. I don't see how doing this would gain anything for localization. Templatizing queryhelp.cgi would work much better if you're worried about localization.
There are loads of other reasons for getting rid of queryhelp.cgi apart from localisability. (And the guide could be localised without changing links using MultiViews or some other mechanism.) Gerv
The problem I have with the regular user guide is it really isn't context help. You can't, say, click on Summary in show_bug.cgi or Summary in query.cgi and get a tailored response for this particular field. Especially for somewhat experienced users, they would want things explained without all the fluff of an entire user guide. There are times when they want something really detailed, and times when they want a short description. I think we should offer both. Perhaps if we do improve the user help, we should allow parameters, such as: help.cgi?from=enter_bug&topic=votes&format=short
> The problem I have with the regular user guide is it really isn't context > help. You can't, say, click on Summary in show_bug.cgi or Summary in query.cgi > and get a tailored response for this particular field. No, but the JS-based help does that. Gerv
Bug 251502 nuked queryhelp.cgi. Marc had some ideas about documenting relative dates when he did review for nuking back in that bug. Although I requested documentation back in that bug, I'm modifying the summary here as well for this to make sense.
Summary: Remove queryhelp.cgi and link to Bugzilla Guide instead → Link to Bugzilla Guide (or provide additional docs) instead of the former queryhelp.cgi
Blocks: 286802
At this point, the bugzilla guide http://www.bugzilla.org/docs/tip/html/query.html does not answer detailed questions about the options on the search page. As far as I can find, queryhelp.cgi is the ONLY place that has instructions for each field.
No longer blocks: 286802
QA Contact: mattyt-bugzilla → default-qa
IMO, bug 182083 and this one are now asking the same implementation, see bug 182083 comment 7. Maybe should we now mark this bug as a dupe of the other one?
Status: NEW → RESOLVED
Closed: 16 years ago
Resolution: --- → WORKSFORME
You need to log in before you can comment on or make changes to this bug.