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

update citation docs #666

Merged
merged 4 commits into from
Dec 9, 2024
Merged

update citation docs #666

merged 4 commits into from
Dec 9, 2024

Conversation

kafitzgerald
Copy link
Contributor

@kafitzgerald kafitzgerald commented Dec 6, 2024

PR Summary

Removes the broken link to the old GeoCAT website citation page and makes a few minor updates to the citation docs for clarity.

The old GeoCAT website citation page for reference: https://github.com/NCAR/GeoCAT/blob/gh-pages/pages/citation.md

At some point we might consider removing the examples on here and swapping them for a sample BibTex entry which is a bit more generic (i.e. not specific to a particular citation style) as well.

Related Tickets & Documents

Closes #665

PR Checklist

General

  • PR includes a summary of changes
  • Link relevant issues, make one if none exist
  • Add a brief summary of changes to docs/release-notes.rst in a relevant section for the upcoming release.
  • Add appropriate labels to this PR
  • PR follows the Contributor's Guide

@kafitzgerald kafitzgerald added the documentation Improvements or additions to documentation label Dec 6, 2024
@kafitzgerald kafitzgerald marked this pull request as ready for review December 6, 2024 19:56
Copy link
Member

@anissa111 anissa111 left a comment

Choose a reason for hiding this comment

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

I think linking to the zenodo page is a way better practice than maintaining a separate citations page, anyway.

Thank you for doing this!

Copy link
Contributor

@jukent jukent left a comment

Choose a reason for hiding this comment

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

Great idea. I wonder if there are other broken links in our documentation that we need to look for now.

@kafitzgerald
Copy link
Contributor Author

Great idea. I wonder if there are other broken links in our documentation that we need to look for now.

I presumed these would also have be caught by the link checker, but in doing a quick search of the code found a link to out to the roadmap as well that we missed. I'll go ahead and wrap that in here as well.

@kafitzgerald kafitzgerald marked this pull request as draft December 9, 2024 17:44
@kafitzgerald kafitzgerald marked this pull request as ready for review December 9, 2024 18:14
@kafitzgerald kafitzgerald merged commit af18d4c into NCAR:main Dec 9, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

link check broken - GeoCAT website
3 participants