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

Updated Credits and Reference Page to include Zenodo Link #4400

Merged
merged 3 commits into from
Apr 16, 2021

Conversation

amystamile-usgs
Copy link
Contributor

Description

Updated zenodo.json file to include contributors listed on Credits page. Updated Credits and References page to include a link to Zenodo release site.

Related Issue

#4183 and #4184

Motivation and Context

Support Sprint 4/12/21

How Has This Been Tested?

Built docs locally and tested html files.

Screenshots (if appropriate):

Screen Shot 2021-04-14 at 11 07 49 AM

Screen Shot 2021-04-14 at 11 06 54 AM

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation change (update to the documentation; no code change)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have read and agree to abide by the Code of Conduct
  • I have read the CONTRIBUTING document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • I have added myself to the .zenodo.json document.
  • I have added any user impacting changes to the CHANGELOG.md document.

Licensing

This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:

This work is free and unencumbered software released into the public domain. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain.

  • I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

@rbeyer
Copy link
Contributor

rbeyer commented Apr 14, 2021

Please run isis/scripts/zenodo_order.py on your zenodo.json file and then commit the output of that as zenodo.json.

And then run isis/scripts/zenodo_to_authors.py to rebuild the main AUTHORS.rst from the zenodo.json file.

Could we write a GitHub workflow for this? Probably. Have we? No.

@amystamile-usgs
Copy link
Contributor Author

amystamile-usgs commented Apr 15, 2021

Please run isis/scripts/zenodo_order.py on your zenodo.json file and then commit the output of that as zenodo.json.

And then run isis/scripts/zenodo_to_authors.py to rebuild the main AUTHORS.rst from the zenodo.json file.

Could we write a GitHub workflow for this? Probably. Have we? No.

@rbeyer Thanks for reminding me on this process. I have done this once before when adding myself to the zenodo file but completely forgot to do the script this time. I will provide an updated commit.

Update: Actually I believe we do have documentation regarding this process. We update the Author's list in our ISIS release procedures Part B: Update the Authors List. I will still go ahead and update the Authors list now since there are large changes to the zenodo file.

Copy link
Contributor

@rbeyer rbeyer left a comment

Choose a reason for hiding this comment

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

Looks good. Those procedures you cite talk about running the zenodo_to_authors.py program, but not the zenodo_order.py program. So I think this probably should spur two Issues, maybe three (but I'm too lazy to write them): (1) The procedures should add using the zenodo_order.py program, (2) Maybe we should write a GitHub Workflow that runs these programs and commits the outputs whenever a commit to .zenodo.json is made?, (3) Maybe we should write some combination thing that does both zenodo_order.py and zenodo_to_authors.py in one swoop? Not sure.

@acpaquette acpaquette merged commit 3dcf145 into DOI-USGS:dev Apr 16, 2021
@amystamile-usgs amystamile-usgs deleted the Credits/References branch May 26, 2021 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

References page should point to latest zenodo release Credits page should redirect to authors/zenodo file
3 participants