Add help documentation to balrog admin-ui

NEW
Unassigned

Status

P5
normal
7 years ago
2 years ago

People

(Reporter: edransch, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

(Whiteboard: [lang=js][lang=html][ready])

(Reporter)

Description

7 years ago
Balrog's admin-ui should have built in help documentation.
The documentation should be available either via links to wiki pages, or directly built-in using docstrings.
Assignee: edransch.contact → nobody
Whiteboard: [balrog]
Product: mozilla.org → Release Engineering
Component: General Automation → Tools
QA Contact: catlee → hwine
mass component change
Component: Tools → Balrog: Frontend
mass priority change after component move
Priority: -- → P3

Updated

4 years ago
Whiteboard: [balrog] → [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2693] [balrog]

Updated

4 years ago
Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2693] [balrog] → [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2701] [balrog]
Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2701] [balrog] → [lang=js][lang=html]
Whiteboard: [lang=js][lang=html] → [lang=js][lang=html][ready]

Comment 3

2 years ago
Hi,

How can I help?
@bhearsum Wasif seems to have found another bug but some information here might be good.
Flags: needinfo?(bhearsum)
Right now, the Balrog Admin UI is not very usefu

Basically, we want some in-context help in the admin UI. Perhaps some tooltips that tell you what is valid for different fields, maybe some way to get a definition or more information for a field (even if it just links to RTD).
Flags: needinfo?(bhearsum)
(In reply to Ben Hearsum (:bhearsum) from comment #5)
> Right now, the Balrog Admin UI is not very usefu

...now very useful unless you already understand Rules, Releases, etc.

> Basically, we want some in-context help in the admin UI. Perhaps some
> tooltips that tell you what is valid for different fields, maybe some way to
> get a definition or more information for a field (even if it just links to
> RTD).

This sort of thing would make it easier for first time users to understand, or even long time users to remember what some obscure feature does.

Comment 7

2 years ago
Is there any place I can reference for the information on this?

Then I can proceed forward with coming up with in-context help.
(In reply to Wasif Hyder from comment #7)
> Is there any place I can reference for the information on this?
> 
> Then I can proceed forward with coming up with in-context help.

http://mozilla-balrog.readthedocs.io/en/latest/index.html has pretty detailed documentation. In particular, the Database Model section has a lot of information on the different fields for Rules, Releases, and Permissions.
Priority: P3 → P5
We did this for the new "mig64" field in https://github.com/mozilla/balrog/pull/372/files#diff-f36a08085552209bdccdf7c156b266e5R152, so we've got a model for how to show it in the UI now. It would be good to rid of the duplication across multiple templates that introduced, though.
You need to log in before you can comment on or make changes to this bug.