search

pyOpenSci / pyopensci.github.io

This is the website for pyOpenSci. Contributions welcome!!
https://www.pyopensci.org
Other
36 stars 61 forks source link

Add: learn page and new tutorials #335

Closed lwasser closed 4 months ago

lwasser commented 5 months ago

This page isn't ready to merge yet. it's a near learn section for our website. there is a good bit more text content development work to do here.

willingc commented 4 months ago

@lwasser I think if you add the pyopensci website to the external links to ignore here, then the new page will not fail as an external link.

lwasser commented 4 months ago

@willingc i worry that would then ignore all pages in that section and not link check. i don't fully understand why it's being recognized as an external link when it's internal. locally it is internal.

there is a swap_url option that htmlproofer offers. where we could force all urls to be local BUT the problem there is our packaging guidebooks use pyopensci.org and we do want to check those links. and they are "technically" external to this website. that that swap_urls would break those links. i may be wrong?

Screenshot 2024-04-02 at 10 49 00 AM
willingc commented 4 months ago

@willingc i worry that would then ignore all pages in that section and not link check. i don't fully understand why it's being recognized as an external link when it's internal. locally it is internal.

there is a swap_url option that htmlproofer offers. where we could force all urls to be local BUT the problem there is our packaging guidebooks use pyopensci.org and we do want to check those links. and they are "technically" external to this website. that that swap_urls would break those links. i may be wrong? Screenshot 2024-04-02 at 10 49 00 AM

All the other links for the website would be internal links for pyopensci in the _site directory. I would give it a shot. We can always remove later.

willingc commented 4 months ago

Oh I see what you mean now. I will be happy when we dump htmlproofer :smile:

lwasser commented 4 months ago

Running as a cron job is super easy.

I think we can also have lychee only run on changed files for the PR check.

@lwasser Oops I edited your comment by accident.

lwasser commented 4 months ago

Running as a cron job is super easy.

I think we can also have lychee only run on changed files for the PR check.

@lwasser Oops I edited your comment by accident.

@willingc 😆 that is awesome. i looked at it and was confused by why i wrote that to myself when i didn't know about lychee beyond what you've added!!

sounds good. i haven't looked at ci yet here. i will do that next.

lwasser commented 4 months ago

ok - let's give this a last review!! @kierisi here is the rendered page with all of the changes we've been talking about here.

i'm thinking once we have some events on the calendar we can add a events section to the page? And then also parse those on the home page as well? but we can implement that in a separate pr to get this one merged. let's focus this one on just getting the content consistent and looking nice as a new section on the website.

i'm also kind of liking the canva graphics. they are easy to make and there is no issues in terms of licensing !!

kierisi commented 4 months ago

ok - let's give this a last review!! @kierisi here is the rendered page with all of the changes we've been talking about here.

i'm thinking once we have some events on the calendar we can add a events section to the page? And then also parse those on the home page as well? but we can implement that in a separate pr to get this one merged. let's focus this one on just getting the content consistent and looking nice as a new section on the website.

i'm also kind of liking the canva graphics. they are easy to make and there is no issues in terms of licensing !!

an events section would be great! it might be nice to put them up as a banner that links to registration.

lwasser commented 4 months ago

overall one thing I've noticed with our website that I find a bit frustrating is that when I click on a header item (such as Learn), I have to choose one of the drop-down items. what I want//expect instead is to be able to click Learn, and then be taken to a Learn landing page that then lets me navigate out to the sub-headers (tutorials, blog, ask a question).

design-wise, there's almost too much white space throughout the page, and I feel like I have to scroll quite a bit to get to information. I don't know how much of this is a limitation of the framework we're using, but it could be nice to tighten things up.

I also think changing the header image to an illustration would help with the overall design of the page, making all of the imagery more internally consistent.

@kierisi this is great feedback. this pr however is focused on the learn page. how about you open an issue so we can talk about bigger things like navigation etc. the header drop downs is tricky. i probably could fix it but i ended up actually writing the javascript myself for those drop downs and it took forever. It's not trivial to add that fix where a click can actually land on a section and open a drop down as you don't know what the user wants to do hover or click. This also gets into responsiveness where on a mobile phone you will always want to click as hover isn't really a thing. so to implement this i'd prefer to move to a platform like bootstrap or tailwind (probably not tailwind!) but you know what i mean... this would be a big migration which the site needs.

so while i appreciate this feedback, it's best in it's own pr and should align with someone else rebuilding the website as we want it using a framework that makes sense and is responsive. minimal mistakes never supported drop downs or bootstrap (and the infra is super dated)! i thing even the grids i adds flex boxes and grid functionality to the theme! it's super hacked.

lwasser commented 4 months ago

an events section would be great! it might be nice to put them up as a banner that links to registration.

Definitely! can you open an issue for this as well? that would be a new feature no specific to just one page! it would be a header / masthead include update!

lwasser commented 4 months ago

New banner!! it's not web optimied size wise but i like it better than the current one. made it in canva! ✨

Screenshot 2024-04-02 at 1 11 45 PM
lwasser commented 4 months ago

ok y'all. this pr has gotten BIG but i do like where it's heading!! i'm going to merge it now. but we have several issues to work on from it

  1. the top bar navigation and potential website overhaul to a better platform (maybe even hugo + bootstrap)
  2. Adding a banner to advertise events. i should be able to knock that out - we will just want to think about how we want to update the banner (maybe via a yaml file?)
  3. fixing lychee / link checking. i think we are moving in the right direction here but it's not catching broken links - yet.
lwasser commented 4 months ago

ok @kierisi THANK YOU for helping me make this page look so so so much better! yahoo! i'm going to merge it. i've taken the last two bigger comments and created issues around website dev. we can tackle those separately given they are site wide fixes rather than just this page which is new content!