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.

Sign up for GitHub

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

Update citation docs and remove broken link #260

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Update citation docs and remove broken link #260

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6523fa9
citation docs update
kafitzgerald Dec 7, 2024
bdba595
update release notes
kafitzgerald Dec 7, 2024
79bfa22
formatting
kafitzgerald Dec 7, 2024
0ba377b
Merge branch 'NCAR:main' into issue258
kafitzgerald Dec 9, 2024
2c4779e
remove broken roadmap link
kafitzgerald Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 13 additions & 22 deletions docs/citation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
1 change: 0 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/release-notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
^^^^^^^^^^^^^^^^
Expand Down
Loading