488940 - Alias field is missing a description in fields.html

Status: RESOLVED FIXED

(Bugzilla :: User Interface, defect)

Description

[Max Kanat-Alexander]

Pyrzak's students' research pointed out that the Alias field isn't described anywhere. It should have a description in fields.html and a link to its documentation.

Comment 1

[GavinS]

Attachment: Add docs for the alias field and links to it v1

Not sure if the documentation should be protected by the
param(usebugaliases), or not, but others are, so this is.

Am happy to adapt or completely replace the text if anyone wants to
specify what it should be.

Note the link is added to the create form and the edit form, in line
with other similar links.

I also added a field to the offline docs, but I confess I have not
generated the full set to check them.

Comment 2

[Frédéric Buclin]

Comment on attachment 412677 [details] [diff] [review]
Add docs for the alias field and links to it v1

>Index: template/en/default/pages/fields.html.tmpl

>+   urls, quicksearch, and any form as an alternative to a [% terms.bug %]

Must be [% terms.abug %].

Comment 3

[GavinS]

Attachment: Add docs for the alias field and links to it v2

Yes - of course, sorry, terms.abug it is.

Comment 4

[Frédéric Buclin]

This looks good, but this is going to conflict with bug 529201, which suggests a complete rewrite of the page. Probably a "blocker will fix". mkanat?

Comment 5

[Max Kanat-Alexander]

Yeah, blocker will fix. Sorry about that.

Comment 6

[Reed Loden [:reed]]

There's absolutely no need to wait for 3.8 for this fix. It's very self-contained and should be acceptable for 3.6 (and even 3.4, really).

Comment 8

[Frédéric Buclin]

Comment on attachment 412699 [details] [diff] [review]
Add docs for the alias field and links to it v2

>Index: template/en/default/pages/fields.html.tmpl

>-<h2><a name="importance">Importance</h2>
>+<h2><a name="importance">Importance</a></h2>

This conflicts with existing code.


>+[% IF Param("usebugaliases") %]
>+  <h2><a name="bug_alias">[% terms.Bug %] Alias</a></h2>

Bugzilla 3.8 uses 'alias' as ID. We should do the same here, for consistency. Also, why is it put at the very end of the file? The order is pretty confusing.


>+  <p>This allows you to refer to [% terms.bugs %] using easily
>+   remembered mnemonics.  The [% terms.bug %] alias can be used in
>+   urls, quicksearch, and any form as an alternative to [% terms.abug %]
>+   id.</p>

We should copy the description from 3.8, IMO, for consistency.



>Index: template/en/default/bug/edit.html.tmpl

>+                ><a href="page.cgi?id=fields.html#bug_alias">Alias<a/></label>:</td><td>

Having only the bug alias linkified but not the bug summary looks strange, IMO.



>Index: docs/en/xml/using.xml

>+        <emphasis>*Alias:</emphasis>

It shouldn't be put between the assignee and QA contact. This doesn't make sense. It should go right before the bug summary, I think.

Comment 9

[Frédéric Buclin]

Bugzilla 3.6 is now restricted to security fixes only, and so we won't fix this bug on this branch. In 4.0 and newer, this bug has been fixed by bug 529201, so adjusting the target milestone and the assignee accordingly.