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

FEAT: Community package listing pages for astropy + SunPy #207

Merged
merged 4 commits into from
Nov 16, 2024

Conversation

lwasser
Copy link
Member

@lwasser lwasser commented Jun 22, 2023

Landing page with community partner buttons

First - the landing page with new community specific buttons at the top leading to a community partner page
Screen Shot 2023-07-05 at 12 18 41 PM

Search feature to find astropy affiliated packages on our main python-packages landing page.

Then we have the landing page where someone might search for astropy to find related packages.
Screen Shot 2023-07-05 at 12 18 31 PM

Community landing page

I envision something like this (styles can be fixed) that listed only the affiliated packages. A few notes

  1. i created a placeholder graphic at the top for astropy - we can change it it's just a mockup.
  2. We should discuss in more detail what metrics we want to track here. I was thinking it would be nice to be able to sort packages by varying metrics.
  3. Based upon what we decide above, we then could create a xml feed that shared data associated with a select group of packages to populate another website. we'd need to agree on what items would be most useful to share in that feed.
Screen Shot 2023-07-05 at 12 27 20 PM

@@ -1,3 +1,90 @@
- package_name: astro-package3
Copy link
Member Author

@lwasser lwasser Jul 5, 2023

Choose a reason for hiding this comment

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

these are just dummy placeholder packages to test the search for astropy functionality - do not worry about the information in each of these but if we need new FIELDS that is something to consider

@pllim
Copy link
Contributor

pllim commented Jul 28, 2023

@lwasser , I vaguely remember you said you added a link back to "original review" to the listing of an accepted package in a mock-up. Was it this mockup? I don't see a preview link and I am not sure if the screenshots are up-to-date. Hope you can clarify. Thanks!

@lwasser
Copy link
Member Author

lwasser commented Jul 28, 2023

hey @pllim i've actually been working on this!! it's not in this mockup branch YET (i need to rebase) BUT you can see it live on the website - i just pushed it. it took me a bit of time as i had to update the code that parses our reviews. but it's done now!! check it our here . now that it's working you can imaging the exact same thing on this mockup branch once i rebase!

Screen Shot 2023-07-28 at 4 35 13 PM

There is a tiny bug i need to fix on the packaging page in terms of sorting but that will be fixed in the next 30 minutes :)

let me know if you have any other questions or if you need anything else. I have it on my list to review the APE in the upcoming days (most likely on monday).

@lwasser lwasser changed the title FEAT: Start at community mockup / astropy FEAT: Start at community mockup / astropy + SunPy Feb 6, 2024
@lwasser lwasser changed the title FEAT: Start at community mockup / astropy + SunPy FEAT: Community package listing pages for astropy + SunPy Feb 6, 2024
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

I don't have a lot of comments when it comes to website designs. I should ping those listed under "Astropy.org web page maintainer" on https://www.astropy.org/team : @hamogu @dhomeier @eteq

At a glance though, you might need Astropy logo and banner that are also compatible with dark mode. We have some here that we use for astropy documentation: https://github.com/astropy/astropy/tree/main/docs/_static

Thanks!

@willingc
Copy link
Collaborator

@lwasser Do we still want this open or should it be closed?

@pllim
Copy link
Contributor

pllim commented Nov 14, 2024

Closed? I thought Astropy had agreement with pyOpenSci on cross-listing? Will this be replaced with something else?

@lwasser
Copy link
Member Author

lwasser commented Nov 15, 2024

oh this definitely needs to be reviewed and merged!! We don't want to close it. this just fell by the wayside with the fall festival and other items going on. I am actually onboarding someone now to help with these types of tasks so they don't go stale because of me!! i'll make sure this one is a priority, but it may be another month until we get up and running with this!

@lwasser
Copy link
Member Author

lwasser commented Nov 15, 2024

@pllim maybe we just merge it as is (with someone fixing whatever is buggy in the pr) and allow for the astropy community to chime in as they see issues in the future? we have a handful of astropy packages now, so the page should look better than when we started with no packages!!

@pllim
Copy link
Contributor

pllim commented Nov 15, 2024

Fine by me but let's hear from @dhomeier and @hamogu as well since they are the current Astropy Affiliated Editors. Thanks!

Copy link

@hamogu hamogu left a comment

Choose a reason for hiding this comment

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

I'm not a javascript programmer, so I can't say much about the implementation, but I still think that we want a page like that - and with the number of accepted packages going up, now is a good time to do so. I suggest to merge this relatively quickly and if we want to iterate on the design (I don't have any strong opinions on that, though) then we can always do that in follow-up PRs.

_pages/python-packages.md Show resolved Hide resolved
@lwasser
Copy link
Member Author

lwasser commented Nov 15, 2024

@hamogu, this sounds good to me.
i'll do this: I'll revisit the PR today, fix the small conflict above, and make it merge-ready. We can always make additional edits to it in the future via opening issues and iterating on it. This pr has been open for over a year so it would be nice to merge it!!


To view packages affiliated with our partner communities that are a part of our peer review partnership program, click on a community link below. [Learn more about our community partnerships here.](#)

<a href="/partners/astropy.html"><button class="button community">Astropy</button></a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should this link be href="/communities/astropy.html"

Copy link
Member Author

Choose a reason for hiding this comment

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

oh i like using the word community in the url over partners. yes let's update it. we will want to update the yaml as well for the page. I will do that locally!!

<li><a href="{{ apackage.archive }}" rel="permalink"><i class="fas fa-bookmark fa-fw"></i> JOSS Approved</a></li>
{% endif %}
{% if apackage.astropy %}
<li><a href="partners/astropy.html"><i class="fa-solid fa-check-double"></i> <img src="http://img.shields.io/badge/Affiliated-Astropy-orange.svg?style=flat" alt="Astropy" /></a></li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Are we using partners or communities in this link?

<li><a href="partners/astropy.html"><i class="fa-solid fa-check-double"></i> <img src="http://img.shields.io/badge/Affiliated-Astropy-orange.svg?style=flat" alt="Astropy" /></a></li>
{% endif %}
{% if apackage.sunpy %}
<li><a href="partners/astropy.html"><i class="fa-solid fa-check-double"></i> <img src="http://img.shields.io/badge/Affiliated-Sunpy-yellow.svg?style=flat" alt="Astropy" /></a></li>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same question here.

overlay_filter: 0.6
overlay_image: images/partners/astropy-banner.png
image_alt: "Digital elevation model"
permalink: partners/astropy.html
Copy link
Collaborator

Choose a reason for hiding this comment

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

communities or partners

@lwasser
Copy link
Member Author

lwasser commented Nov 16, 2024

Ok friends. I am going to merge this with the updates.
we may want to adjust text and such. AND I think I found a bug where some package categories are not displayed /filtered properly in the isotope. I will turn this comment into an issue that we can track separately.

The new page shows 3 Astropy packages have been accepted! 🚀

@lwasser
Copy link
Member Author

lwasser commented Nov 16, 2024

the ci failures

  • new partner page (fixed when this is merged)
  • a DOI link issue. that could just be a zenodo issue.

@lwasser lwasser merged commit d9d34a6 into pyOpenSci:main Nov 16, 2024
3 of 4 checks passed
@lwasser lwasser deleted the astropy branch November 16, 2024 00:33
@pllim
Copy link
Contributor

pllim commented Nov 18, 2024

@pllim
Copy link
Contributor

pllim commented Nov 18, 2024

FWIW I opened a couple of follow-up issues. Thanks again, all!

@lwasser
Copy link
Member Author

lwasser commented Nov 19, 2024

wonderful. thanks @pllim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DO-NOT-MERGE A caution that a PR is not ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants