Update citation docs and remove broken link (#260)

* citation docs update * update release notes * formatting * remove broken roadmap link
NCAR · Dec 11, 2024 · 3179551 · 3179551
1 parent 42f6fc3
commit 3179551
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 23 deletions.
diff --git a/docs/citation.rst b/docs/citation.rst
@@ -11,33 +11,24 @@ 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
-<https://zenodo.org/search?page=1&size=20&q=conceptrecid:%226678345%22&sort=-version&all_versions=True>`_.
+DOIs for all the GeoCAT-viz versions can be found `here on Zenodo
+<https://zenodo.org/search?q=parent.id%3A6678345&f=allversions%3Atrue&l=list&p=1&s=10&sort=version>`_.
 
+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. (\<Year\>).
-    Geoscience Community Analysis Toolkit: GeoCAT-viz (v\<version\>) [Software].
-    Boulder, CO, USA: NSF NCAR Computational and Information Systems Lab. doi:\<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:
 
-For further information, please refer to
-`GeoCAT homepage - Citation <https://geocat.ucar.edu/pages/citation.html>`_.
+    **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.**
diff --git a/docs/index.rst b/docs/index.rst
@@ -86,7 +86,6 @@ plotting packages.
 
    Release Notes <release-notes.rst>
    Contributor's Guide <contrib.rst>
-   Roadmap <https://geocat.ucar.edu/pages/roadmap.html>
 
 .. toctree::
    :maxdepth: 2

diff --git 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
 ^^^^^^^^^^^^^^^^