1053203 - Treeherder help "Builds & Tests" section should be removed

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P5)

Description

[Sylvestre Ledru [:Sylvestre]]

On this page:
https://treeherder.allizom.org/ui/help.html

the builds & tests section should be automatically generated from the database and the description should be displayed too.

Comment 1

[Ed Morley [:emorley]]

Ah I didn't realise it was hardcoded :(
https://github.com/mozilla/treeherder-ui/blob/master/webapp/app/help.html

I'd filed bug 1052489 for this, but let's keep this bug and make bug 1052489 just about the tooltips.

Comment 2

[Jonathan French (:jfrench)]

We've mad made further customizations to the Builds/Tests sections, manually adding links for Spidermonkey and other jobs for Releng eg. https://github.com/mozilla/treeherder-ui/pull/395/files and https://github.com/mozilla/treeherder-ui/pull/394.

I am not sure if it precludes auto generation, but it seems to be evolving more towards a manually maintained model.

Comment 3

[Ed Morley [:emorley]]

I'm still not keen on hardcoding things in help and having to keep them up to date.
Also, to me, help shouldn't really be about lists of job names and links to their info (that should be somewhere else), but instead actual help about the webapp :-)

Comment 4

[Jonathan French (:jfrench)]

+1. I think those Build/Tests tables might be suitable for RTD, or something similar. :)

We also have in-app tooltips on each job element which kind of replicates the information, and those often seem more informative.

Comment 5

[Cameron Dawson [:camd]]

In triage with Ed:  We agree that this data gets out of date too quickly and doesn't add anything more useful than you would get by just hovering or selecting the job type in question.  So if more data about a job could be provided, it should reside upstream in TaskCluster somewhere.  But the data in these sections really isn't useful and should be removed.

Comment 6

[Ed Morley [:emorley]]

The relevant code is here:
https://github.com/mozilla/treeherder/blob/9f0a90343c4940c866074726c4f05fdfa22ac4d8/ui/userguide.html#L171-L407

Comment 7

[GitHub Bugzilla PR Linker]

Attachment: Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3164

Comment 8

[Jonathan French (:jfrench)]

Comment on attachment 8945180 [details] [review]
Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3164

Purge ahoy :)

Comment 9

[Ed Morley [:emorley]]

Comment on attachment 8945180 [details] [review]
Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3164

One small tweak :-)

Comment 10

[Jonathan French (:jfrench)]

Comment on attachment 8945180 [details] [review]
Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3164

Ok, I think ready to go now.

Comment 11

[Ed Morley [:emorley]]

Comment on attachment 8945180 [details] [review]
Link to GitHub pull-request: https://github.com/mozilla/treeherder/pull/3164

Many thanks!

Comment 12

[Treeherder GitHub Bugbot]

Commit pushed to master at https://github.com/mozilla/treeherder

https://github.com/mozilla/treeherder/commit/247e1b980ce98048fc3df12416d6bb6f1fe4d582
Bug 1053203 - Remove builds and tests tables from user guide (#3164)