pyOpenSci / pyopensci.github.io

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

Fix: peer review landing page #287

Closed lwasser closed 9 months ago

lwasser commented 9 months ago

This is an attempt the make the peer review landing page on our website a bit more user focused with a narrative. it breaks the page into sections.

Current status:

lwasser commented 9 months ago

to view the rendered page you can go here

in the artifacts section of our circleci build!! i will swap out images with more fitting graphics once we have stable content . right now i just used the same image over and over as a placeholder.

willingc commented 9 months ago

It looks great @lwasser. :sunny:

lwasser commented 9 months ago

thank you so much @willingc will be making and integrating all of these changes in the next day.

lwasser commented 9 months ago

the related fix to the author page in our peer review guide here

the idea being that an author hits the peer review page and then can be directed to the author guide in the "Ready to submit" section. That guide page then has relevant sections of the guide for them to review creating an author content pathway.

Screenshot 2023-11-29 at 3 51 07 PM
willingc commented 9 months ago

Awesome @kierisi. Love the alt text additions. @lwasser I will let you rereview content and it looks good to me.

lwasser commented 9 months ago

ok updates! ✅ i've merged all of your input here @kierisi thank you so much for all of the content edits. I welcome a second round if you wish to look at things again ✅ i've cleaned up the styles for the page - specifically the text and block at the bottom was too wide to be readable.

what's left

The current rendered page can be seen here

@kierisi please in working on this page i realized the JOSS section had been removed so i added it back. I also think we could have images that are a bit less square to balance the page out some.

i'm going to open a separate PR to update our partners page. @kierisi i suspect you'll have really good feedback for that page as well. it's a similar style but also needs some cleanup of messaging and brand. i might be able to create better diagrams now that i'm using canva more but it still has some AI generated images of people (we do want representations of people all over!!)

willingc commented 9 months ago

@lwasser @kierisi May I make a small suggestion about PRs...

When making changes that are fluid (I.e. text, images, styling), it's often easier to create multiple PRs instead of combining into one PR.

I typically ask myself:

For example, I would recommend landing all of the content changes in this PR, create another PR for the images, and another for the styling.

lwasser commented 9 months ago

@lwasser @kierisi May I make a small suggestion about PRs...

When making changes that are fluid (I.e. text, images, styling), it's often easier to create multiple PRs instead of combining into one PR.

I typically ask myself:

  • Is this one change better than what is already there?
  • Can this change stand alone without other changes?
  • Is there any significant downside to one PR landing a day or two before the next PR? (I use the Issues to keep track of to do items.)

For example, I would recommend landing all of the content changes in this PR, create another PR for the images, and another for the styling.

Thank you @willingc this is helpful. i will definitely think about this more carefully for future pr's. In this case when i went to edit the page there was a lot of inline HTML with styles applied there that made the content more difficult to review.

so i pulled that html out and tried to move all of the text to the front matter for simplified editing and then templated content via includes and styles that could be resused. it was easier for me to do this all at once but i can see how as a reviewer it would make for a more complex review. i'll think about how to parse those elements out separately in the future. it's just a bit tricky when some of these pages were created a bit haphazardly (by me!)

we have asana tasks locally to track updates to images. But we can't edit alt tags on the page until images are fixed. i'm open to suggestions that you have about how to chunk the work buckets out a bit more cleanly as well.

willingc commented 9 months ago

@lwasser Looks like there is a merge conflict here.

lwasser commented 9 months ago

ok! the only downside of merging it now is there is one image i used 3-4 times on the page.

but i suppose we could just embrace a second pr that updates those images knowing not that many people will be on the page nor will they judge us for using an image several times? but i'll go ahead and merge and might just put other placeholder images in via a later pr (from the partners page) .