search

astropy / astropy.github.com

The Astropy web pages
http://www.astropy.org
BSD 3-Clause "New" or "Revised" License
43 stars 100 forks source link

Update affiliated package listing script to get from pyopensci #579

Closed eteq closed 6 months ago

eteq commented 8 months ago

This is a follow on from #573 - in the interest of rolling that out quickly I think we should deal with fixing the script separately from updating the infoormation on the affiliated page.

So this issue is to update the old script, or (more likely)... make a new one to pull the listing from pyopensci's listing.

A few unanswered questions:

pllim commented 8 months ago

When I thought about freezing the "legacy affiliation" page, I didn't think about the case where someone of a listed package just want to update, say, the website or maintainer list, while still being ok with it under "legacy". Should we allow such a change after the freeze? If so, maybe we have to keep the script to make it easier on them.

hamogu commented 8 months ago

I think we should allow changes like that, e.g. changes in the website might occur at no fault of the maintainer, e.g. if their hosting provider stops supporting something. We would not trigger a re-review for that, so we should not make them go through pyopensci just for that.

However, such changes are rare. If we have good reason to get rid of the script (but if it works and nothing is broken, we might as well leave it), editing pure html would be acceptable for changes like that.

pllim commented 6 months ago

@eteq , I found two issues here that you might be interested in:

dhomeier commented 6 months ago

It seems the Packages list does not highlight it yet, but the metadata already contains the relevant information for e.g. ZodiPy identifying our packages now – parse

partners:
    - astropy
pllim commented 6 months ago

Right now, I can think of 3 different things we can do:

  1. Use jekyll like https://github.com/pyOpenSci/pyopensci.github.io (e.g., https://github.com/pyOpenSci/pyopensci.github.io/pull/207)
  2. Modify https://github.com/astropy/astropy.github.com/blob/main/js/functions.js to parse YAML from https://github.com/pyOpenSci/pyopensci.github.io/blob/main/_data/packages.yml with the partners:\n\t- astropy filter Derek mentioned above.
  3. Write out the HTML by hand.

@eteq ?

eteq commented 6 months ago

I'm not a fan of 1 because I think that could be a major project with unforeseen consequences. 2 feels much more maintainable to me than 3.

I didn't realize https://github.com/astropy/astropy.github.com/issues/579#issuecomment-2108190251 until now, though, which makes me think this might be a lot easier (i.e. "less javascript"...) than I was earlier thinking, so thanks @dhomeier !

pllim commented 6 months ago

this might be a lot easier (i.e. "less javascript"...) than I was earlier thinking

@eteq , can you please elaborate?

pllim commented 6 months ago

Please review https://github.com/astropy/astropy.github.com/pull/590 . Thanks!