1009216 - Add link to a wiki page describing common whiteboard tags

Status: RESOLVED FIXED

Description

[Dietrich Ayala (:dietrich)]

Tim Chien brought this up when asking whether there was a central page that explained the whiteboard flags currently in use.

Perhaps we could link it to a wiki page where people could write down:

* what the flag means
* who to ask about it
* whether it's currently in use or obsolete

Comment 1

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Woot!

Comment 2

[David Lawrence [:dkl]]

I think this is an excellent idea and we can definitely do the needed change on BMO using template hooks to override the help text and display the link. Someone would need to provide the proper reliable link to a maintained page and we can get that added.

dkl

Comment 3

[Tim Guan-tin Chien [:timdream] (please needinfo)]

https://wiki.mozilla.org/BMO/Whiteboard ?

Comment 4

[Tim Guan-tin Chien [:timdream] (please needinfo)]

To unblock this bug, let's just add a placeholder with proposed format of the sections. I hope people will start filling the page since it will be quite visible when this feature is landed.

Comment 5

[Tim Guan-tin Chien [:timdream] (please needinfo)]

MDN can help to but I am not aware of any BMO section there.

Comment 6

[Tim Guan-tin Chien [:timdream] (please needinfo)]

:dkl,

To make this happen I would like to take this bug. Could you give me some pointer on how should I submit a patch? Documentation or another bug as an example will help. Thanks.

Comment 7

[David Lawrence [:dkl]]

(In reply to Tim Guan-tin Chien [:timdream] (MoCo-TPE) (please ni?) from comment #6)
> :dkl,
> 
> To make this happen I would like to take this bug. Could you give me some
> pointer on how should I submit a patch? Documentation or another bug as an
> example will help. Thanks.

Sure you are welcome to work on this bug. We have a developer bmo box you can use to do the patch if you want located at:

https://wiki.mozilla.org/BMO/DeveloperBox

The file that needs to be updated is here:

extensions/BMO/template/en/default/hook/bug/field-help-end.none.tmpl

Then once you have a patch, just upload it here and r? me and I will take a look at it.

dkl

Comment 8

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Created attachment 8426575 [details] [diff] [review]
Patch

I didn't change field-help-end.none.tmpl because the intend outcome of this bug is to link the label directly to wiki page.

Tell me if I need to change that file too. Apparently there isn't any link there so I am not sure I should add the first one.

Comment 9

[David Lawrence [:dkl]]

Comment on attachment 8426575 [details] [diff] [review]
Patch

Review of attachment 8426575 [details] [diff] [review]:
-----------------------------------------------------------------

I would rather we backport the use of field-label.html.tmpl that is being used in newer version upstream and then we can pass this wiki URL in to that template
to override the default help text. Like this:

[% INCLUDE "bug/field-label.html.tmpl"
   field     = bug_fields.status_whiteboard
   editable  = 1
   accesskey = "w"
   desc_url  = "https://wiki.mozilla.org/BMO/Whiteboard"   
 %]

See other uses of field-label.html.tmpl for reference.

Comment 10

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Created attachment 8427553 [details] [diff] [review]
WIP

Yeah that works too. This however just like the "URL:" label will make the "Whiteboard:" label lost it's underline at "W".

Thanks for the very obvious tip.

Comment 11

[David Lawrence [:dkl]]

Comment on attachment 8427553 [details] [diff] [review]
WIP

Review of attachment 8427553 [details] [diff] [review]:
-----------------------------------------------------------------

Looks good. I have filed a new bug and have a patch under review that addresses the underline character issue separately. We can commit this patch 
now and the issue will be resolved when we backport bug 1015226.

Comment 12

[David Lawrence [:dkl]]

Thanks for the patch!

To ssh://[e-mail]/webtools/bmo/bugzilla.git
   a94a60e..8decb5b  master -> master