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

Update affiliated package listing script to get from pyopensci #579

Closed
eteq opened this issue Mar 18, 2024 · 8 comments · Fixed by #590
Closed

Update affiliated package listing script to get from pyopensci #579

eteq opened this issue Mar 18, 2024 · 8 comments · Fixed by #590
Assignees

Comments

@eteq
Copy link
Member

eteq commented Mar 18, 2024

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:

  • How to keep the "legacy" affiliated packages that may not be in pyopensci?
  • How to separately manage the coordinate packages since they have to be accepted separtely
  • Can we ditch the old script completely eventually? Or will it need to stay active long-term to support the above?
@eteq eteq self-assigned this Mar 18, 2024
@pllim
Copy link
Member

pllim commented Mar 18, 2024

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
Copy link
Member

hamogu commented Mar 18, 2024

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
Copy link
Member

pllim commented Apr 29, 2024

@dhomeier
Copy link
Contributor

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
Copy link
Member

pllim commented May 13, 2024

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., FEAT: Community package listing pages for astropy + SunPy pyOpenSci/pyopensci.github.io#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
Copy link
Member Author

eteq commented May 13, 2024

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 #579 (comment) 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

This comment was marked as resolved.

@pllim
Copy link
Member

pllim commented May 17, 2024

Please review #590 . Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants