-
Notifications
You must be signed in to change notification settings - Fork 30
Standardize citation guidance #161
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
base: main
Are you sure you want to change the base?
Conversation
* Update environment.yml * notebook run with bumped versions * remove colab fluff * revert immaterial changes * run on s3-style url * recalc multiples * typo
|
updating CNG logo
Forum name update
Zenodo is enabled on the org now, waiting for the sync to catch up so I can enable it on the repo. Based on this, we're going to say the authors own the copyright? (pretty much rules out ever changing the license, which can be ok) Should we update the date though. Or rely on occasional versioning to update that? Usually for website citation it would just be an Accessed date anyways. |
The intersection between copyrights and licensing is not my expertise, so I defer to your understanding of this.
I think we should use |
I removed the changes to the copyright notice to limit the scope of this PR. |
Thanks for setting up the integration @wildintellect! Zenodo's default of including all GitHub contributors as the authors made me realize that my initial default of pulling the author list from the slides may be insufficient. Do you have thoughts on an authorship policy? A couple options:
|
I don't really have an idea of what's the threshold for becoming an "author" but this is part of why I think the Preferred Citation in https://guide.cloudnativegeo.org/contributing.html#licensing is what we'd want most people to use (and we could improve it) |
I disagree with that being an appropriate citation to recommend because it doesn't follow any normative conventions and is therefore unusable for any peer-reviewed contexts (e.g., the motivation for #96). I also personally don't agree with leaving off authors from an acknowledgement because it's not easy to decide who deserves credit. |
@maxrjones ah that's a change in APA I hadn't seen https://owl.purdue.edu/owl/research_and_citation/apa_style/apa_formatting_and_style_guide/reference_list_author_authors.html the old style was 3 or more authors then only list 1st author et al. Now it's up to 20 authors. My threshold, would be non-trivial edits, typo or link correction being examples of trivial, qualifies as authorship. |
|
||
> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. <TBA> | ||
|
||
Please visit the Guide's [DOI link](TBA) to get the most recent version - the one above is not automatically generated and may be out of date as we release updated versions of the Guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a todo for later to see if we can use the Zenodo API to return the up to date citation, or quarto build hook.
|
||
The citation will look something like: | ||
|
||
> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. <TBA> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. <TBA> | |
>Aimee Barciauskas, Kyle Barron, Zac Deziel, Alex I. Mandel, Jed Sundwall, Julia Signell, Max Jones, Jonas, Leo Thomas, Jamison French, Tyler Erickson, Rajat Shinde, Kiri, Daniel Sparing, Blayne Chard, Brian Mc Donald, James Bourbeau, Luis López, autarc, & rsignell. (2025). Cloud Optimized Geospatial Formats Guide: https://doi.org/10.5281/zenodo.15498529 |
This is a slightly edited APA style citation.
Looks like Harvard and MLA are actually close to the current, it's fine to redirect people to the DOI zenodo page for other styles.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be clear I'm copying and pasting from the Citation generator on Zenodo with minor edits.
|
||
> Aimee Barciauskas, TBA (2023). cloudnativegeo/cloud-optimized-geospatial-formats-guide: Cloud Optimized Geospatial Formats Guide v2025.05.21 (v2025.05.21). Zenodo. <TBA> | ||
|
||
Please visit the Guide's [DOI link](TBA) to get the most recent version - the one above is not automatically generated and may be out of date as we release updated versions of the Guide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way we can avoid having to maintain this in 2 places?
CITATION.cff
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is Zenodo supposed to use this file for it's citation because it seems to be ignoring it. Oh it's because we have to commit this and release. So it looks like we have some alignment to do between the git metadata and the cff file.
This PR addresses #52 and #96 by aligning all content to refer to the preferred citation and removing the copyright notice at the bottom of the website, since it disagreed with the citation and the citation was included in more locations, so is taken as authoritative for the purpose of this PR.
This approach would require a release on Zenodo to get a DOI - would that approach be alright with you @zacdezgeo and @wildintellect? I could set it up if it's possible to become an admin on this repository.
Closes #52
Closes #96