Many cookbooks' DOI badge links don't work

[erogluorhan]

What happened:

Clicking on the DOI badge link of several rendered cookbooks in the gallery returns "DOI not found". For instance: https://projectpythia.org/cesm-lens-aws-cookbook/ (and many others)

What is interesting is that this doesn't happen in the repositories' README DOI links. Investigating the URLs of the DOI badges:

This is what I get from the rendered cookbook: https://doi.org/10.5281/zenodo.509240024
This is what is coming from the repo: https://zenodo.org/badge/latestdoi/509240024

Zenodo now provides DOI links for projects slightly differently, and it can definitely be applied to all of our cookbooks, but rather than going that route first, figuring out why the badge link is changing throughout rendering might be better.

@jukent @dcamron any thoughts?

See this comment below for the current status of the problem.

[kafitzgerald]

Looks similar to ProjectPythia/pythia-foundations#553 where the URL w/ latestdoi in it isn't properly handled by MyST.

It doesn't really look like there's been much movement on addressing the underlying issue (continuous-foundation/doi-utils#27).

Another option could be to use the Zenodo Concept DOI (i.e. the all versions DOI) instead. That's what this open PR on Foundations is doing (stalled for reasons other than the PR itself): https://github.com/ProjectPythia/pythia-foundations/pull/592/files

[erogluorhan]

Thanks for pointing that out; I wasn't aware! Since it has already covered everything I put into this one, I'll close it. Also, yes, I've used Zenodo's concept DOI for the time being for UXarray's cookbooks.

[brian-rose]

Reopening this because the problem still needs to be resolved for existing cookbooks. All the DOI badges currently displayed on our gallery are broken.

[erogluorhan]

Current status:

1. Cookbooks that are using the older DOI badge URLs now have their DOI MyST badges point to "DOI badge Not Found" error. Note that this is only happening on the MyST-rendered html pages, and those same badges work as expected on the README files in their repos.
   i. Maintainers have recently switched some of the cookbooks to Zenodo's latest-version DOI URLs, and it seems to have fixed the error, but there is a cosmetic behavior as described below in (2).
   ii. Since DOI badges in README files work just fine and get broken after the MyST rendering, I'd suggest that we communicate with MyST before attempting to change DOI badges in all our cookbooks - like what is done in (i)
2. Also, seemingly with recent versions of MyST, formatting of the badges on our rendered pages started to look odd, as described here.
   • This is worth discussing with MyST, too.
   • At least one cookbook though, ESGF cookbook, seems to be using Zenodo's latest DOI badge URL and does not seem to have this cosmetic problem.

FYI: @jukent is planning to have a look into this soon, probably coordinating with @dcamron and MyST folks, maybe @agoose77

[brian-rose]

Interesting. I suspect that the badges are still working in the ESGF cookbook because it hasn't been rebuilt since last summer (according to commits in its gh-pages branch). Somehow it was spared the mangling of the DOI links by MyST that were described in ProjectPythia/pythia-foundations#553.