Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create landing page for training materials #157

Merged
merged 23 commits into from
Mar 18, 2024
Merged

Conversation

Bisaloo
Copy link
Member

@Bisaloo Bisaloo commented Dec 12, 2023

  • The post specifies a license if you don't want to use the default CC BY
  • All authors have an ORCID iD
  • Relevant keywords / tags has been added. In particular, if you want your post to be shared on R-bloggers, you must tag it with R
  • Images or other external resources have been committed and pushed
  • The post uses pure quarto syntax, rather than HTML or R code, unless necessary

Right before merging:

  • The date field has been updated
  • All reviewers have been acknowledged in a short paragraph
  • A PR has been opened in the blueprints to link to this post
  • The post has been re-rendered and content of the _freeze/ folder is up-to-date

Copy link

netlify bot commented Dec 12, 2023

Deploy Preview for tourmaline-marshmallow-241b40 ready!

Name Link
🔨 Latest commit c53d829
🔍 Latest deploy log https://app.netlify.com/sites/tourmaline-marshmallow-241b40/deploys/65f844543ab51c00087d5ccc
😎 Deploy Preview https://deploy-preview-157--tourmaline-marshmallow-241b40.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@chartgerink chartgerink marked this pull request as ready for review February 6, 2024 12:54
@chartgerink
Copy link
Member

@Bisaloo - this is ready for a review as well - but given that you opened the PR I can't request you directly :-)

https://deploy-preview-157--tourmaline-marshmallow-241b40.netlify.app/learn

@avallecam
Copy link
Member

avallecam commented Feb 8, 2024

Thank you, @chartgerink @Bisaloo for working on this.

Here is some initial feedback that I'm happy to discuss and find alternatives.

  • The grid listing provides a nice visual outlook, which we want to keep. Is it possible to arrange them linearly in a specific order? I'm interested in its linearity because we would be able to highlight some external resources from the community, integrating the idea of the learning path.
  • As we shared in a reference issue at tutorials repo, our references for this are the lessons tab from carpentries website, with a similar outlook for the Ecology curriculum, and the galaxy project training site. Is there a way we can reconcile the vision shared and the tools Quarto provides? Features that are informative to both learners and instructors are the columns of site, repository, reference, instructor notes, and list of maintainers.

I have the (possibly biased) idea that a listing format like the one used in the howto index site (here qmd file) could open the possibility of sections with the listing within each section. To keep the visuals, instead of table, the default one. Happy to read your thoughts!

@rozeggo input on this issue will also be helpful.

@rozeggo
Copy link
Member

rozeggo commented Feb 13, 2024

Hi Chris/Hugo. This looks nice but the grid listing may be hard to categorise/order the lessons? Maybe I am misunderstanding a little bit the plan, but I thought we were aiming for a layout like this: https://software-carpentry.org/lessons/
this would also allow easier correlation of translated materials as well as linking to the repo for the training.

@chartgerink
Copy link
Member

Thanks for the feedback @rozeggo and @avallecam!

As far as I can tell, there was no scope document available so I was unaware of these requirements. Are there any additional things I need to be aware of before working on this?

@chartgerink chartgerink marked this pull request as draft February 19, 2024 12:35
@chartgerink
Copy link
Member

Had a chat with @avallecam about this and we found a way forward. Reverted this pull request to draft until it's in a ready state again.

@Bisaloo
Copy link
Member Author

Bisaloo commented Feb 19, 2024

@avallecam, to be sure before @chartgerink spends more time on this: does the proposed format support non-sandpaper lessons, such as the e-Epi-Training Kit Laura is developing?

@avallecam
Copy link
Member

avallecam commented Feb 19, 2024

@avallecam, to be sure before @chartgerink spends more time on this: does the proposed format support non-sandpaper lessons, such as the e-Epi-Training Kit Laura is developing?

@Bisaloo thank you for your question. the proposed format will include non-sandpaper materials in isolated tables (refer to the preliminary Google Doc draft document) per type of material: e-learning platform, tutorials, how-to guides, and case studies, so the number of columns between the name and the dev-stage can vary depending on the each.

@avallecam
Copy link
Member

@avallecam, to be sure before @chartgerink spends more time on this: does the proposed format support non-sandpaper lessons, such as the e-Epi-Training Kit Laura is developing?

@Bisaloo thank you for your question. the proposed format will include non-sandpaper materials in isolated tables (refer to the preliminary Google Doc draft document) per type of material: e-learning platform, tutorials, how-to guides, and case studies, so the number of columns between the name and the dev-stage can vary depending on the each.

for homogeneity across isolated tables, we can take the approach used by galaxy (link to reference)

chartgerink and others added 2 commits February 29, 2024 13:47
Co-authored-by: Andree Valle Campos <[email protected]>
Co-authored-by: Andree Valle Campos <[email protected]>
@chartgerink chartgerink marked this pull request as ready for review February 29, 2024 13:08
@chartgerink
Copy link
Member

This PR is now ready for review and will stay open for a week or so.

Please add anyone who needs to be consulted on this PR. It's been through several iterations now so please focus on details over fundamental changes.

@avallecam
Copy link
Member

thanks @chartgerink for opening this PR. @Bisaloo @lgbermeo could we have your review for this during the next week?

Copy link
Member Author

@Bisaloo Bisaloo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks everyone for your work on this! I can't officially approve since I opened this PR but ✔️

Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with how this page is displayed. My main interest now is about the cellphone display and how appropriate is the naming of the research software curriculum. I'm open to read your alternatives.


### Tutorials in English

| Tutorial | Site | Repository | Instructor Schedule | Development stage |
Copy link
Member

@avallecam avallecam Feb 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at how this looks on the cellphone (Please, see attached screenshot), I'm interested in finding ways to increase the width of the name column.

Screenshot:
image

I think:

  • one could be to change the column name of the last column from Development stage to Stage. Any strong opinion on this?
  • other, to combine the name and site columns, linking them directly in the name, as previously tested by @chartgerink in this PR.

Also, we may have an increase benefit mixing both alternatives. Here I'm proposing the first one:

Suggested change
| Tutorial | Site | Repository | Instructor Schedule | Development stage |
| Tutorial | Site | Repository | Instructor Schedule | Stage |

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for the record, this is the outlook of the name and site columns mixed from a cellphone

WhatsApp Image 2024-02-29 at 13 03 39_740f334f

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@avallecam please provide final input for the tables. I have changed them back and forth several times already, so in order to prevent any further issues, I will await your specific instructions for the final revision as part of this PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the final table outlook. I moved extra suggestions to separate issues to solve in other PRs #207 and #208

Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

adding feedback from @lgbermeo

chartgerink and others added 2 commits March 18, 2024 09:40
Co-authored-by: Hugo Gruson <[email protected]>
Co-authored-by: Hugo Gruson <[email protected]>
Copy link
Member

@avallecam avallecam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As stated in #157 (comment) I agree with the final table outlook. The cellphone format currently provides full words per line and looks more readable. For me, this is ready to merge 🚀

@chartgerink chartgerink merged commit 1c7c745 into main Mar 18, 2024
2 checks passed
@chartgerink chartgerink deleted the landing-training branch March 18, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants