Add help documentation to balrog admin-ui

NEW
Unassigned

Status

Release Engineering
Balrog: Frontend
P5
normal
6 years ago
20 days ago

People

(Reporter: edransch, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

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

(Reporter)

Description

6 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.

Updated

4 years ago
Assignee: edransch.contact → nobody
Whiteboard: [balrog]
(Assignee)

Updated

4 years ago
Product: mozilla.org → Release Engineering

Updated

4 years ago
Component: General Automation → Tools
QA Contact: catlee → hwine
mass component change
Component: Tools → Balrog: Frontend
mass priority change after component move
Priority: -- → P3

Updated

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

Updated

3 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]

Updated

7 months ago
Whiteboard: [kanban:engops:https://mozilla.kanbanize.com/ctrl_board/6/2701] [balrog] → [lang=js][lang=html]

Updated

7 months ago
Whiteboard: [lang=js][lang=html] → [lang=js][lang=html][ready]

Comment 3

6 months ago
Hi,

How can I help?

Comment 4

6 months ago
@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

5 months 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
You need to log in before you can comment on or make changes to this bug.