1046639 - Make the treeherder-ui and treeherder-service repo READMEs more comprehensive

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

The READMEs are currently pretty empty:

https://github.com/mozilla/treeherder-ui/blob/cbc742666fd20312122faa0012a842a9e8a5c8fe/README.md

https://github.com/mozilla/treeherder-service/blob/a7da323cebc6864b63bde2b25931cd24b0baa26e/README.md

Whilst the code-specific docs (eg installation/setup) should stay in readthedocs (and thus only be linked to from the README, rather than inline), we can still add some of the content from the wiki page, eg:
* Quick description
* Link to wiki
* Cross links (and explanation) between the UI and service repos
* File a bug link
...

Comment 1

[Jonathan French (:jfrench)]

I'm having a look at treeherder-ui right now, assigning myself.

Comment 2

[Jonathan French (:jfrench)]

I've done a more comprehensive readme for treeherder-ui (part1 in Description) which includes the items listed, and iterated with jeads on it in-channel. I will open a PR shortly.

Comment 3

[Jonathan French (:jfrench)]

Attachment: treeherder-ui-PR#119

I've opened a PR as per above comments. Please see the PR for reviewers and review status.

Comment 4

[Jonathan French (:jfrench)]

I've updated the treeherder-service readme also (part2 in Description), and similarly iterated with jeads in-channel. It will have a similar flavour and appearance. I will open a PR for that repo shortly.

Comment 5

[Jonathan French (:jfrench)]

Attachment: treeherder-service-PR#186

I've opened a PR for treeherder-service also, per above comments. Please see the PR for reviewers and review status.

Comment 6

[Jonathan French (:jfrench)]

Part 1 (treeherder-ui) merged and fixed in master
https://github.com/mozilla/treeherder-ui/commit/b05a3c668aef60aa9a2c2cd2203e61b0661269ae#diff-d41d8cd98f00b204e9800998ecf8427e

Comment 7

[Jonathan French (:jfrench)]

Part 2 (treeherder-service) also merged and fixed in its master
https://github.com/mozilla/treeherder-service/commit/659ccbbc2b423a7b60125d9bf5d4a6079e275ea4#diff-d41d8cd98f00b204e9800998ecf8427e

Both appear fine. Marking fixed.

Comment 8

[Ed Morley [:emorley]]

Looks good - thank you :-)