1046590 - Add an easy to find contribute link to treeherder's main UI

Status: RESOLVED FIXED

(Tree Management :: Treeherder, defect, P2)

Description

[Ed Morley [:emorley]]

Filed from:
https://github.com/mozilla/treeherder-ui/pull/103

 sylvestre commented 8 days ago:
Add links to the source code and the bug tracker from the footer #103 
It helps to attract new potential contributors.


 maurodoglio commented 8 days ago
Thanks @sylvestre, this is a very good idea. I'm not sure about where to place it though. We may want to integrate those links in the top bar to be more prominent. @jeads , @camd what do you think about it?


 edmorley commented 8 days ago
I think it might be better to link to the wiki page since the source link in this PR is only for the UI and not the service - and there are also the Read the docs pages etc. Linking to the wiki would give them all of these without spamming the footer.

ie:
> <a href="https://wiki.mozilla.org/Auto-tools/Projects/Treeherder">Contribute</a>
or
> <a href="https://wiki.mozilla.org/Auto-tools/Projects/Treeherder">File bug / Source</a>

Comment 1

[Ed Morley [:emorley]]

Attachment: sylvestre's PR#103

Comment 2

[Sylvestre Ledru [:Sylvestre]]

I prefer directly links to the sources. Having always direct links to the sources creates a consistency over projects. 
Each documentations being different, sometime, the link to find the sources is not obvious (or the link to report bugs).
Having them directly available in the footer helps to quickly get access to it.

I don't think that is spamming.

Comment 3

[Ed Morley [:emorley]]

The problem is that there isn't just one repo. We also then really need links to readthedocs etc. This gives at a minimum 6 links required:
1) treeherder-service source
2) treeherder-ui source
3) treeherder-service RTD
4) treeherder-ui RTD
5) The overall wiki page
6) A "file a bug" link.

I agree other projects aren't great at making their wiki pages easy to follow - but I'd say https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Hacking lists the links pretty clearly?

Comment 4

[Ed Morley [:emorley]]

(In reply to Ed Morley [:edmorley] from comment #3)
> 6) A "file a bug" link.

Note we're not using github issues.

Comment 5

[Ed Morley [:emorley]]

Thinking about this more, let's fill out:
https://github.com/mozilla/treeherder-ui/blob/master/README.md
and
https://github.com/mozilla/treeherder-service/blob/master/README.md
...since it would be good to do that anyway (using some of the content from the wiki page).

And then as another option we could always link just to the {treeherder-ui repo, wiki page} from the footer, as long as the treeherder-ui README explains about the existence of the service repo and what types of things require changes in that. 

I'm almost wondering if it would just be easier if we combined the treeherder-service and treeherder-ui repos... :-/

Comment 6

[Jonathan French (:jfrench)]

Sylvestre are you still working on this bug w.r.t. your open PR?

Comment 7

[Jonathan French (:jfrench)]

I've done a clean, but comprehensive readme for treeherder-ui and iterated with jeads on it in-channel for bug 1046639, I'll likely open a PR tomorrow for it in that bug.

Comment 8

[Sylvestre Ledru [:Sylvestre]]

Oups, I missed that in my bugmail. Sorry, I will have a look tomorrow.

Comment 9

[Jonathan French (:jfrench)]

Thanks Sylvestre, I can try doing the footer also if needed. But if you are doing this bug I'll just update the readmes. Whichever you prefer.

Comment 10

[Sylvestre Ledru [:Sylvestre]]

I am not sure what you exactly want but in this patch:
https://github.com/sylvestre/treeherder-ui/commit/605c05b0d4d91fbfe6be35a876035b43c5aae1b1
I proposed:
Source code / Hacking / Bug report

Source code = https://github.com/mozilla/treeherder-ui
Hacking = https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Hacking
Bug report = https://bugzilla.mozilla.org/enter_bug.cgi?product=Tree+Management&component=Treeherder

I can also update that to point to README files.

Comment 11

[Jonathan French (:jfrench)]

Hi Sylvestre, sorry I was told in the past to add the need info flag to request response; I didn't need any specific details per-se. My question is - you have an open PR for this bug, but it is not assigned. Should you be assigned this bug to fix it, or is it an open bug for others to fix?

Comment 12

[Sylvestre Ledru [:Sylvestre]]

(In reply to Jonathan French (:jfrench) from comment #11)
> Hi Sylvestre, sorry I was told in the past to add the need info flag to
> request response;
That is right :)
> I didn't need any specific details per-se. My question is
> - you have an open PR for this bug, but it is not assigned. Should you be
> assigned this bug to fix it, or is it an open bug for others to fix?
I can take it, no worries.
I created the PR here:
https://github.com/mozilla/treeherder-ui/pull/120

Comment 13

[Jonathan French (:jfrench)]

Thanks Sylvestre, I will assign the bug to you in that case.

Comment 15

[Sylvestre Ledru [:Sylvestre]]

Attachment: bug1046590.diff

Comment 16

[Mauro Doglio [:mdoglio]]

Comment on attachment 8479216 [details] [diff] [review]
bug1046590.diff

Review of attachment 8479216 [details] [diff] [review]:
-----------------------------------------------------------------

::: webapp/app/index.html
@@ +25,5 @@
>          </div>
>  
>          <!-- Footer -->
> +        <div class="text-center">
> +          <a href="https://github.com/mozilla/treeherder-ui">Source code</a> / <a href="https://wiki.mozilla.org/Auto-tools/Projects/Treeherder#Hacking">Hacking</a> / <a href="https://bugzilla.mozilla.org/enter_bug.cgi?product=Tree+Management&component=Treeherder">Bug report</a>

can you please add a target="_blank" to these links? Every link to an external resource in the ui opens a new tab afaik.

Comment 17

[Sylvestre Ledru [:Sylvestre]]

Attachment: 0001-Bug-1046590-Add-links-to-the-source-code-and-the-bug.patch

with target="_blank"

Comment 18

[Sylvestre Ledru [:Sylvestre]]

Merged. Thanks
https://github.com/mozilla/treeherder-ui/commit/ce6625b8a6fa383cf506c5b497c69f9e82ed6359

Comment 19

[Treeherder GitHub Bugbot]

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

https://github.com/mozilla/treeherder/commit/eedfab49f78ce884fe81103c1d2d08d9ba5b626d
Bug 1046590 - Add links to the source code and the bug tracker from the footer r=mdoglio