739241 - Add help documentation to balrog admin-ui

Status: RESOLVED WONTFIX

(Release Engineering Graveyard :: Applications: Balrog (frontend), defect, P5)

Description

[Erick Dransch [:edransch]]

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.

Comment 1

[[e-mail] (:bhearsum)]

mass component change

Comment 2

[[e-mail] (:bhearsum)]

mass priority change after component move

Comment 3

[Wasif Hyder]

Hi,

How can I help?

Comment 4

[Ninad Bhat[:ninad101]]

@bhearsum Wasif seems to have found another bug but some information here might be good.

Comment 5

[[e-mail] (: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).

Comment 6

[[e-mail] (: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

[Wasif Hyder]

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

Then I can proceed forward with coming up with in-context help.

Comment 8

[[e-mail] (:bhearsum)]

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

Comment 9

[[e-mail] (:bhearsum)]

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.

Comment 10

[[e-mail] (:bhearsum)]

Mass closure of old Balrog UI bugs. We've built a new UI in https://github.com/mozilla-frontend-infra/balrog-ui, and any issues which are still valid should be filed as Issues there.