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

Add DOIs to citations on RTD #815

Merged
merged 2 commits into from
Jul 26, 2024
Merged

Add DOIs to citations on RTD #815

merged 2 commits into from
Jul 26, 2024

Conversation

trey-stafford
Copy link
Contributor

Description

Add DOIs to QGreenland citations on ReadTheDocs. https://qgreenland.readthedocs.io/en/latest/citing.html

Checklist

If an item on this list is done or not needed, check it with [x] or click the
checkbox.

  • The PR description links to issues that it resolves with closes #{issue_number}
  • Config lockfile updated (inv config.export > qgreenland/config/cfg-lock.json)
  • Environment lockfile updated if needed (conda-lock)
  • Version bumped if needed (bumpversion (major|minor|patch|prerelease|build))
  • CHANGELOG.md updated (for user-facing changes)
  • Documentation updated if needed
  • New unit tests if needed

@trey-stafford trey-stafford marked this pull request as ready for review July 25, 2024 23:46
Copy link
Contributor

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

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

LGTM!

@@ -44,39 +44,47 @@ An asterisk (`*`) indicates co-equal lead authorship (listed alphabetically).

> Moon, T. A., M. Fisher, T. Stafford, and A. Thurber (2023). QGreenland ({{ release }})
> [dataset], [National Snow and Ice Data Center](https://qgreenland.org/).
> doi: [10.5281/zenodo.12823307](https://doi.org/10.5281/zenodo.12823307)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the bumpversion-driven citation section. The {{ release }} bit above is a myst substitution based on the software's current version number.

I hard-coded the DOI to v3, our latest release, but a future release will mean this is wrong.

We could use the "cite all versions" doi here, but it does mean that someone that copies and uses this citation, intending to get the v3 citation, might end up with a DOI that points to e.g., v4 in a year or two from now. Maybe that's not a huge concern, since the version number would still be in the citation?

@mfisher87 , any thoughts?

@twilamoon-science twilamoon-science merged commit d8b755d into main Jul 26, 2024
3 checks passed
@mfisher87 mfisher87 deleted the add-doi-to-citations branch July 26, 2024 15:49
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.

3 participants