Closed Bug 1762134 Opened 2 years ago Closed 2 years ago

Update BMO user guide to list "Project Flags" too in addition to "Tracking Flags"

Categories

(bugzilla.mozilla.org :: Documentation, task)

Tracking

()

RESOLVED FIXED

People

(Reporter: marco, Assigned: marco)

Details

For example, open https://bugzilla.mozilla.org/show_bug.cgi?id=857031, hover on "Project Flags" and see that the link is "https://wiki.mozilla.org/BMO/UserGuide#Tracking_Flags".

For Performance, it should instead point to https://wiki.mozilla.org/Performance/Bugzilla#Project_Flag.

If there is no way to set a link on the specific Project Flags, I think we should link to a page with a list of all project flags.

The problem with making this change is that the text for the performance wiki page is specific to that project flag and not all project flags we have defined in BMO. There are 10 total project flags active and each have their own distinct list of values. The help link would be the same for all project flags which would cause confusion.

It would require a code change but we could add a more detailed description in the DB for each project/tracking flag that would be displayed when you hover the flags name in the left column of the flags table.

We can go with the easier and quicker option of having a single page to list the project flags, and then from that page have links to the specific project flag pages.

(In reply to Marco Castelluccio [:marco] from comment #3)

We can go with the easier and quicker option of having a single page to list the project flags, and then from that page have links to the specific project flag pages.

Well no code change is needed if we just edit the current landing page for the help link. And then allow the user to click another wiki page for the list of project flags and their more detailed descriptions. I don't mind still doing a code change if there is a better, more generic, page we can link to.

Would you be able to the wiki edits and come up with the project flag page with the descriptions for me?

Flags: needinfo?(mcastelluccio)

Good point, updating that page will be even easier than creating a new one!

Do you have a full list of the project flags?
I think as a first step we can simply add a list, and then slowly add links to specific pages.

I'll assign this to myself since I'll be doing the wiki edits.

Assignee: nobody → mcastelluccio
Status: NEW → ASSIGNED
Flags: needinfo?(mcastelluccio)
Type: defect → task
Component: Bug Creation/Editing → Documentation
Summary: Help text on the "Project Flags" for the "Performance" field is pointing to the tracking flags documentation → Update BMO user guide to list "Project Flags" too in addition to "Tracking Flags"

(In reply to Marco Castelluccio [:marco] from comment #5)

Good point, updating that page will be even easier than creating a new one!

Do you have a full list of the project flags?
I think as a first step we can simply add a list, and then slowly add links to specific pages.

cf_a11y_review_project_flag a11y-review project 0 Yes Copy
cf_webcompat_priority Webcompat Priority project 0 Yes Copy
cf_data_science_product_support_area Product Support Area (PSA) project 0 Yes Copy
cf_bmo_component_move bmo-component-move project 0 Yes Copy
cf_root_cause Root Cause project 0 Yes Copy
cf_firefox_messaging_system Firefox Messaging System project 0 Yes Copy
cf_performance Performance project 0 Yes Copy
cf_tracking_firefox_sumo user-doc-firefox project 304 Yes Copy

Oh, it looks like there is a Project Flags section on that same page (https://wiki.mozilla.org/BMO/UserGuide#Project_Flags). I will update it to add the project flags you mentioned.

Maybe it's better to change the link on project flags to point to https://wiki.mozilla.org/BMO/UserGuide#Project_Flags then, and leave the Tracking Flags section only for Tracking Flags.

cf_data_science_product_support_area is no longer used, so I filed bug 1762672 to delete it and I won't add it to the list.

Same for cf_bmo_component_move, I filed bug 1762675.

Same for cf_root_cause, I filed bug 1762930.

Updated the bug page template to point to the proper wiki links.
https://github.com/mozilla-bteam/bmo/commit/8e864c485e3ea9f54f4dea9a77cc28cc9f02b796

Perfect, thanks!

I'm still waiting on info for cf_firefox_messaging_system and cf_tracking_firefox_sumo, and then we can call this fixed.

I filed bug 1764192 for deleting cf_firefox_messaging_system.

In some bugs I also see cf_fission_milestone in the "Project Flags", but it isn't in your list from comment 7. Is it a different kind of field?

Flags: needinfo?(dkl)

(In reply to Marco Castelluccio [:marco] from comment #15)

In some bugs I also see cf_fission_milestone in the "Project Flags", but it isn't in your list from comment 7. Is it a different kind of field?

Yeah it is not a normal tracking flag and is instead a custom field in Bugzilla.

Flags: needinfo?(dkl)

I filed bug 1764592 for disabling cf_fission_milestone.

I filed bug 1764783 for disabling cf_tracking_firefox_sumo, as it looks like it isn't used anymore.

All fields are either documented or removed, we can close this.

Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.