403397 - Missing documentation about keywords

Status: RESOLVED FIXED

(Bugzilla :: Documentation, enhancement)

Description

[Frédéric Buclin]

No documentation can be found about administering keywords. We should explain how they work, if they are per-product or global (currently global), if you can mark a keyword as old to prevent new entries (this is not yet implemented, but if we don't tell it, an admin cannot guess), etc...

Comment 1

[Sam Folk-Williams]

Do you have an idea where this should go?

Right now there is a very brief description here:
http://www.bugzilla.org/docs/tip/html/bug_page.html

Should we just expand that with more details or actually make a new section, say after the Flags section in Chapter 5?

Comment 2

[Frédéric Buclin]

The link you are pointing to in comment 1 is about using keywords in bugs, not about administering them. I don't say the explanation is great, but other fields are not better. That's something to fix in a separate bug.

I want this bug to focus on the administration of keywords and a section should be added at http://www.bugzilla.org/docs/tip/html/administration.html right after section 3.8 Flags. So we should have 3.9 Keywords, moving Custom fields to 3.10.

Comment 3

[Sam Folk-Williams]

Attachment: first draft

OK attaching first draft - note I included an xref to a new section in a patch on bug 45207. Until/Unless that patch gets committed, this wont compile right. Let me know if we should just drop it.

Comment 4

[Colin Ogilvie [:cso]]

Comment on attachment 298013 [details] [diff] [review]
first draft

r=me

Comment 5

[Frédéric Buclin]

tip:

Checking in docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.80; previous revision: 1.79
done

3.0.3:

Checking in docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.70.2.7; previous revision: 1.70.2.6
done

Comment 6

[Frédéric Buclin]

2.22.3:

Checking in docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.55.2.12; previous revision: 1.55.2.11
done

2.20.5:

Checking in docs/xml/administration.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/administration.xml,v  <--  administration.xml
new revision: 1.50.2.15; previous revision: 1.50.2.14
done