search

nsidc / qgreenland

Source code for generating the QGreenland package hosted at https://qgreenland.org/
https://qgreenland.readthedocs.io
Other
36 stars 9 forks source link

Keep version number in documentation citation up-to-date with bumpversion #634

Closed MattF-NSIDC closed 1 year ago

MattF-NSIDC commented 1 year ago

This PR removed the version from the citation, but we should add it back and auto-update it:

https://github.com/nsidc/qgreenland/pull/445/files

... Maybe we don't need to do this? Should our citation be generic and version-less? What if a user used the plugin to get some QGreenland layers? I think just citing "QGreenland" without worrying about whether Core or Custom was used is best.

twilamoon-science commented 1 year ago

It is valuable to be able to cite with DOI different versions of QGreenland Core, but just for the primary LTR versions. Not sure what that means about citing various versions along the way...

MattF-NSIDC commented 1 year ago

@twilamoon-science what do you think about where we landed? We have a citation for the latest version, then all the LTR versions in descending order.

https://qgreenland.readthedocs.io/en/latest/citing.html

MattF-NSIDC commented 1 year ago

In case you find stuff you want to continue to tweak, here's the source file! https://github.com/nsidc/qgreenland/blob/main/doc/citing.md

twilamoon-science commented 1 year ago

This looks great. Thanks! Is there a way we might add a link to the part about the "Interacting with Geospatial Data tutorial"? I'm assuming yes, but haven't looked up how to add that to the code yet.

MattF-NSIDC commented 1 year ago

Good catch! Opening another issue for that now.