From 6523fa965864202437c7772a097425e34e3adaa4 Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Fri, 6 Dec 2024 19:10:27 -0700 Subject: [PATCH 1/4] citation docs update --- docs/citation.rst | 36 ++++++++++++++---------------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/docs/citation.rst b/docs/citation.rst index 1e1b243..be38fdd 100644 --- a/docs/citation.rst +++ b/docs/citation.rst @@ -11,33 +11,25 @@ users to access older releases. This ensures that users are not only able to cit software version through DOIs but are also able to download & use the corresponding release for reproducibility purposes. -Please find DOIs for all the GeoCAT-viz versions `here -`_. +DOIs for all the GeoCAT-viz versions can be found `here on Zenodo +`_. +Example citations +^^^^^^^^^^^^^^^^^ -If you would like to cite GeoCAT-viz as a whole (without referring to a specific version), use -the following text: - - **Visualization & Analysis Systems Technologies. (2020). - Geoscience Community Analysis Toolkit: GeoCAT-viz [Software]. - Boulder, CO: NSF NCAR Computational and Information Systems Lab. doi:10.5281/zenodo.6678345.** - -Instead, if you would like to cite a specific version of GeoCAT-viz, use the following text: - - **Visualization & Analysis Systems Technologies. (\). - Geoscience Community Analysis Toolkit: GeoCAT-viz (v\) [Software]. - Boulder, CO, USA: NSF NCAR Computational and Information Systems Lab. doi:\.** - -In the above citation text, update the year, GeoCAT-viz version, and DOI as appropriate. For -example: +Citing a specific version of GeoCAT-viz: **Visualization & Analysis Systems Technologies. (2022). Geoscience Community Analysis Toolkit: GeoCAT-viz (v2022.05.0) [Software]. Boulder, CO, USA: NSF NCAR Computational and Information Systems Lab. doi:10.5281/zenodo.6678351.** -Please note: The DOI minting service, Zenodo, might be suggesting their own citation text (as -they are the publisher of such DOIs) in their website. We prefer the text we recommend here to be used; -however, either way is acceptable. +.. attention:: + + Requires updating the year, GeoCAT-viz version, and DOI + +Citing GeoCAT-viz without referring to a specific version: + + **Visualization & Analysis Systems Technologies. (2020). + Geoscience Community Analysis Toolkit: GeoCAT-viz [Software]. + Boulder, CO: NSF NCAR Computational and Information Systems Lab. doi:10.5281/zenodo.6678345.** -For further information, please refer to -`GeoCAT homepage - Citation `_. From bdba595e588f75878eea8fe46c820bcc37964b31 Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Fri, 6 Dec 2024 19:11:58 -0700 Subject: [PATCH 2/4] update release notes --- docs/release-notes.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes.rst b/docs/release-notes.rst index d9b2eba..da53fbd 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -12,6 +12,7 @@ Documentation ^^^^^^^^^^^^^ * Remove link to broken NCL_vector_5.py example by `Katelyn FitzGerald`_ in (pr::`249`) * Fix documentation theme configuration by `Katelyn FitzGerald`_ in (pr::`253`) +* Minor updates and removal of broken link on citation page by`Katelyn FitzGerald`_ in (pr::`260`) Internal Changes ^^^^^^^^^^^^^^^^ From 79bfa22b573e25a78d9fe232411aa7ed8b55b774 Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Fri, 6 Dec 2024 19:13:53 -0700 Subject: [PATCH 3/4] formatting --- docs/citation.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/citation.rst b/docs/citation.rst index be38fdd..139cc53 100644 --- a/docs/citation.rst +++ b/docs/citation.rst @@ -32,4 +32,3 @@ Citing GeoCAT-viz without referring to a specific version: **Visualization & Analysis Systems Technologies. (2020). Geoscience Community Analysis Toolkit: GeoCAT-viz [Software]. Boulder, CO: NSF NCAR Computational and Information Systems Lab. doi:10.5281/zenodo.6678345.** - From 2c4779e707402c8f3dd320e4a679a5cc2c4a421a Mon Sep 17 00:00:00 2001 From: Katelyn FitzGerald <7872563+kafitzgerald@users.noreply.github.com> Date: Mon, 9 Dec 2024 13:13:58 -0500 Subject: [PATCH 4/4] remove broken roadmap link --- docs/index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index f034b7c..d344466 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -86,7 +86,6 @@ plotting packages. Release Notes Contributor's Guide - Roadmap .. toctree:: :maxdepth: 2