76392 - Review and update quicksearch documentation

Status: RESOLVED INVALID

(Bugzilla :: User Interface, enhancement)

Description

[Sean Richardson]

Andreas has asked me to review the documentation for
http://bugzilla.mozilla.org/quicksearch.html and
http://bugzilla.mozilla.org/quicksearchhack.html

I'll make some comments, and potentially add a patch, then hand this bug
back to Andreas to finalize and check in the documentation changes.

Comment from Jesse Ruderman in bug 76073:
> Btw, the documentation gives an example of "+brow  does not find all bugs in 
> the  Browser  product".  This is confusing, because the example says what 
> doesn't happen without saying what does happen.  I think the example should be 
> replaced with 'For example, use "+news" to find bugs with "news" in the 
> summary without also finding all bugs in the MailNews product'.)
...makes sense to me.

Off the top, the biggest improvement to the documentation from the 
point of view of getting users knowledgable about what they can do, and
how to do it, would be to provide some examples of searches that use more
than bare word(stem)s. Comparing examples with reference material makes for
faster learning than working from only examples or only reference material.

Andreas, perhaps you could copy a few moderately complex searches that
you use here, to begin building a bank of examples.

Comment 1

[Andreas Franke (gone)]

Example 1: Open bugzilla bugs blocking the 2.12 release
		milestone:2.12
or		OPEN :bugzilla milestone:2.12

Example 2: Open bugs targeted at mozilla 0.9:
		milestone:0.9 -milestone:0.9.1
Support for alternative comparison operators like "exact" is bug 76498.

Examples from http://www.ags.uni-sb.de/~afranke/mozilla/quicksearchhack.html :

:<area>		product,component:<area>
	:browser	bugs in the Browser product
	:mail		bugs in the MailNews product
	:xbl		bugs in the XBL component
<sev>		severity:<sev>
	blo,cri,maj	severe bugs
  	enh		enhancement requests
p<level>	priority:<level>
	p1		very high-priority bugs
	p1-2		high-priority bugs
@<owner>	assignedto:<owner>
	@nobody		ownerless bugs
	@mozilla.org	bugs assigned to mozilla.org members
!<keyword>	keywords:<keyword>	
	!crash		crasher bugs
	!helpwanted	bugs waiting for your help

More examples when I have more time. Maybe in a week or two.

Comment 2

[Dave Miller [:justdave]]

-> Bugzilla/Documentation

Comment 3

[Dave Miller [:justdave]]

online user help - moving to user interface

Comment 4

[Dave Miller [:justdave]]

The User Interface component now belongs to Gerv.  Reassigning all UNCONFIRMED
and NEW (but not ASSIGNED) bugs currently owned by Myk (the previous component
owner) to Gerv.

Comment 5

[Dave Miller [:justdave]]

Reassigning back to Myk.  That stuff about Gerv taking over the User Interface
component turned out to be short-lived.  Please pardon our confusion, and I'm
very sorry about the spam.

Comment 6

[Myk Melez [:myk] [@mykmelez]]

Hmm, not really a bug, but a note about a review that apparently never happened.
 If there's a specific issue with the QuickSearch documentation that needs
correcting, then reopen and change the summary to reflect that.