Closed Bug 76392 Opened 23 years ago Closed 20 years ago

Review and update quicksearch documentation

Categories

(Bugzilla :: User Interface, enhancement)

enhancement
Not set
normal

Tracking

()

RESOLVED INVALID

People

(Reporter: sidr, Assigned: myk)

References

()

Details

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.
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.
Depends on: 107860
-> Bugzilla/Documentation
Assignee: sidr → barnboy
Component: Mozilla Developer → Documentation
Product: Documentation → Bugzilla
QA Contact: endico → matty
online user help - moving to user interface
Assignee: barnboy → myk
Component: Documentation → User Interface
OS: Windows NT → All
Hardware: PC → All
Target Milestone: --- → Bugzilla 2.18
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.
Assignee: myk → gerv
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.
Assignee: gerv → myk
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.
Severity: normal → enhancement
Status: NEW → RESOLVED
Closed: 20 years ago
No longer depends on: 107860
Resolution: --- → INVALID
Target Milestone: Bugzilla 2.18 → ---
QA Contact: matty_is_a_geek → default-qa
You need to log in before you can comment on or make changes to this bug.