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 and remove broken link #260

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

kafitzgerald
Copy link
Collaborator

@kafitzgerald kafitzgerald commented Dec 7, 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.

Closes #258

PR Checklist

General

  • Make an issue if one doesn't already exist
  • Link the issue this PR resolves by adding closes #XXX to the PR description where XXX is the number of the issue.
  • Add a brief summary of changes to docs/release-notes.rst in a relevant section for the next unreleased release. Possible sections include: Documentation, New Features, Bug Fixes, Internal Changes, Breaking Changes/Deprecated
  • Add appropriate labels to this PR
  • Make your changes in a forked repository rather than directly in this repo
  • Open this PR as a draft if it is not ready for review
  • Convert this PR from a draft to a full PR before requesting reviewers
  • Passes precommit. To set up on your local, run pre-commit install from the top level of the repository. To manually run pre-commits, use pre-commit run --all-files and re-add any changed files before committing again and pushing.

@kafitzgerald kafitzgerald added the documentation Improvements or additions to documentation label Dec 7, 2024
@kafitzgerald
Copy link
Collaborator Author

kafitzgerald commented Dec 7, 2024

Just noting the failures here are not from the changes but rather a pre-existing issue addressed by #257, which should probably just be merged first. Adding a blocked label to make that more obvious.

@kafitzgerald kafitzgerald marked this pull request as ready for review December 7, 2024 02:19
@kafitzgerald kafitzgerald added the blocked Work got blocked waiting the output of some other source/work label Dec 7, 2024
@jukent
Copy link
Collaborator

jukent commented Dec 9, 2024

Just noting the failures here are not from the changes but rather a pre-existing issue addressed by #257, which should probably just be merged first. Adding a blocked label to make that more obvious.

Was going to ask why this was blocked. Don't you love when 2 PRS are failing because the other isn't merged yet?

@kafitzgerald kafitzgerald removed the blocked Work got blocked waiting the output of some other source/work label Dec 9, 2024
@kafitzgerald kafitzgerald marked this pull request as draft December 9, 2024 18:11
@kafitzgerald kafitzgerald marked this pull request as ready for review December 9, 2024 18:14
@kafitzgerald kafitzgerald requested a review from jukent December 9, 2024 20:39
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 from GeoCAT website update
2 participants