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

Fix some link issues #544

Merged
merged 1 commit into from
Jan 7, 2025
Merged

Conversation

erik-whiting
Copy link
Contributor

I am attempting to address #525, #526, and possibly pyOpenSci/pyosMeta#228.

Regarding #525, I am not entirely sure that the problem still exists? You say the issue_link isn't rendering, but the badge and text that says "View Review" is wired to the value of issue_link and seems to be linking just fine. Can you confirm that this is still a problem and clarify a little bit?

Regarding #526, this seems to be happening because there are no astropy: true lines in the packages.yml file. Likewise, there are no sunpy: true lines in the file, despite the fact that you (@lwasser) added at least one such line in this PR: #207. I cannot figure out when that line was deleted, but I opted instead to check for the presence of "sunpy" or "astropy" in the list of partners for a package and use that as a boolean. I added sunpy as a community to the package from the above-linked PR.

Regarding pyOpenSci/pyosMeta#228, I am a little confused on this. The links are not working because in the packages.yml file, some of them are written out as markdown, but Jekyll is blindly pasting that markdown on top of the base url link. For example, currently, the "JOSS Approved" link for sourmash is pointing to https://www.pyopensci.org/[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10951577.svg)](https://doi.org/10.5281/zenodo.10951577), which I'm guessing is not what you want. You could write something like {{ apackage.joss | markdownify }} in the package-grid.html file, but this method "smartly" parses the markdown and turns it into HTML, you would have to do some extra work to get it to keep the "JOSS Review" look it has now and still link to the appropriate URL. Instead, in this PR, I standardized the archive links and pasted them if a joss link was present. I did not standardize the joss links because the existing code does not use the .joss value of a package anyway, so I wanted to maintain the spirit of what was already there.

I may have missed something or causes some tests to fail, I'm not sure, and I'm not totally familiar with the architecture of this site, so please let me know if I broke something or if there's something you want me to fix. As of right now, at least locally, things work and look how they're supposed to--at least what I think they're supposed to look like.

@lwasser
Copy link
Member

lwasser commented Jan 7, 2025

hey @erik-whiting thank you so much for this!! The way this works is that pyosMeta (the package) parses our peer review issues and returns a packages.yml file. The workflow that calls this is below:

https://github.com/pyOpenSci/pyopensci.github.io/blob/main/.github/workflows/update-contribs-reviews.yml

When that happens, it updates the contributors.yml and the packages.yml file. So this pr will fix some links but it will then get overwritten in two weeks when the above workflow runs again.

In the doi side of things, @banesullivan is working on normalizing all of our dois in pyosMeta to ensure that we have consistent returns of these values. then we can do less "cleaning" on the Jekyll side of things.

For the partnership side of things, we haven't yet formally partnered with Sunpy, but we are with Astropy. Someone could check that they want to be considered for affiliation. Still, we can't assume the Astropy community accepts them unless we see the Astropy label on the issue, which an Astropy editor will vet. So, I think the fix for astropy is likely due to a change in how we parsed the partner label!

if you are game, let's use the partners list key in the packages.yml file. If astropy is there (rather than a boolean), we can add the Astropy affiliation text to the card. this should be a straightforward Jekyll fix. We can merge your link changes, but please know they will be overwritten when the next cron job runs!!

Please let me know if you have any questions, and THANK YOU so much for fixing this for us! Welcome to pyOpenSci !!

@@ -45,10 +45,10 @@ <h3 class="card__title no_toc" itemprop="headline">
{% if apackage.joss %}
<li><a href="{{ apackage.archive }}" rel="permalink"><i class="fas fa-bookmark fa-fw"></i> JOSS Approved</a></li>
{% endif %}
{% if apackage.astropy %}
{% if apackage.partners contains "astropy" %}
Copy link
Member

Choose a reason for hiding this comment

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

@erik-whiting i'm sorry what i asked you to do is exactly what you did. let's go ahead and merge this knowing the other changes will get overwritten in the next contributor update.

@lwasser lwasser merged commit 3f3af25 into pyOpenSci:main Jan 7, 2025
3 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants