galaxyproject / training-material

A collection of Galaxy-related training material
https://training.galaxyproject.org
MIT License
294 stars 846 forks source link

Make authors' list more welcome to more contributions #2868

Closed Chinonyemildred closed 2 years ago

Chinonyemildred commented 2 years ago

In response to the issue reported by @bebatut in issue #2835, I created a direct call to action which is also a hyperlink, the call to action clearly states, "Interested in contributing to this material?". When they click the link, it takes them directly to the How to contribute tutorial page where they can learn and be directed on how to contribute to the material.

I noticed the call to action was not directly under the authors list, what do you think about it?

Chinonyemildred commented 2 years ago

I'm wondering why there is still conflict here....I pulled before making any commit

Chinonyemildred commented 2 years ago

I resolved the conflict.. :)

bgruening commented 2 years ago

Thanks, I triggered the test!

Chinonyemildred commented 2 years ago

Thank you @bgruening, I noticed there's a failing test....what could be wrong?

shiltemann commented 2 years ago

@Chinonyemildred if you click on "Details" next to the failing test, you can find the following error message:

Liquid Exception: Could not locate the included file '_includes/contributor-badge-list.html' in any of 
["/home/runner/work/training-material/training-material/"]. Ensure it exists in one of those directories 
and, if it is a symlink, does not point outside your site source. in /home/runner/work/training-material/training-material/_layouts/tutorial_hands_on.html

the file you are including contributor-badge-list.html does not exist, so please double-check what you wanted to do there

hexylena commented 2 years ago

Hi @Chinonyemildred, it seems you're working off of an older version of the GTN, we've replaced the contributor-badge-list.html with contributor-list.html (as you can see by what the diff looks like). Could you please update your GTN branch and start again?

Chinonyemildred commented 2 years ago

The layout for the tutorial page is there: https://github.com/galaxyproject/training-material/blob/main/_layouts/tutorial_hands_on.html. The authors list is added on line 64 using https://github.com/galaxyproject/training-material/blob/main/_includes/contributor-badge-list.html which then display badges using https://github.com/galaxyproject/training-material/blob/main/_includes/contributor-badge.html

This is where the contributor badges link is....I didn't work on that though. I only added a line of code to make the list more open to contribution. Since the link doesn't lead outside the site, how do I resolve this please?

hexylena commented 2 years ago

Hi @Chinonyemildred one of the issues is that this file does not exist anymore, we changed that quite recently. https://github.com/galaxyproject/training-material/blob/main/_includes/contributor-badge-list.html

Your branch is quite far behind the main branch of the GTN

image

You need to fix this first I'm afraid, before the pull request can be merged

hexylena commented 2 years ago

The "Lint broken links" is a bit of a bad name, it will also catch general build failures (like requiring a template which no longer exists on the main branch of the codebase)

Chinonyemildred commented 2 years ago

Wow....okay, thank you. I'll work on that

Chinonyemildred commented 2 years ago

I have corrected the pending issue as directed by @shiltemann. Thank you so much

shiltemann commented 2 years ago

@Chinonyemildred I was inspired by your idea to style it a bit like a contributor badge, wondering what you think:

image

Clicking it will still link to the contributing topic.

If you like this idea, I can add the changes to this PR.

Chinonyemildred commented 2 years ago

@shiltemann this is beautiful! Yes, we can have that....totally!

shiltemann commented 2 years ago

ok cool, pushed! If you could quickly check that everything looks ok that would be helpful (e.g. both on tutorials and on the slides)

Chinonyemildred commented 2 years ago

Okay, I'll do that now

Chinonyemildred commented 2 years ago

It looks great on slides and tutorial and merges with the author badges design. Great work!

I was wondering if the call to action was clear and and inviting...Two words to keep the consistency of the badges yet clear enough to arouse an interest.

Please what do you think?

I was thinking in the lines of: "Add contributions" "Make contributions"

Do they sound more inviting? If not, let's go with what we have as it's beautiful already

shiltemann commented 2 years ago

I think that is good too, definitely makes it more obvious that it can be clicked :+1:

Chinonyemildred commented 2 years ago

I edited it to 'Make Contributions!'....

What do you think?

shiltemann commented 2 years ago

@Chinonyemildred I like it! (it looks like you did "Add" instead of "Make", but I think both are good so will leave it up to you which one you prefer :)

Chinonyemildred commented 2 years ago

Oh yea! I had realized that the word 'Add' is a more precise CTA than 'Make'. It's funny that Make still stuck with me when putting up my description😂😂.

We're good to go👍🏻

bebatut commented 2 years ago

Thanks a lot @Chinonyemildred !!!