Improved authorship credits#612
Conversation
|
👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below. |
|
Waiting on ProjectPythia/pythia-config#21 before the full author list looks correct here. |
|
This PR also adds a heads-up statement about our JOSE paper while we wait for a DOI to be issued (#605). |
|
Also, this PR is essentially a workaround for the lack of support in MyST for controlling how (or whether) the author list is displayed at the top of each rendered page. This may well change in the future. Tracking related MyST feature issues jupyter-book/mystmd#1664 and jupyter-book/mystmd#2394. If it becomes possible to do things like display all authors on each page but put them in a discreet dropdown box, then we can move the full author list back to the book-level |
|
Neat changes, thanks for the helpful context |
kafitzgerald
left a comment
There was a problem hiding this comment.
Thanks, this looks good to me overall (especially given the current constraints).
I did see a blank entry that got inserted (see comment). Not sure if this is intended or something that might be easy to drop.
|
Thanks folks! Merging now. |
This PR addresses #604 and does a few things related to authorship credits:
CITATION.cfffile with one that can be dynamically created by MyST by runningmyst build preamble/how-to-cite.mdMy thinking here is that the full author list to just too long to display on every page. However I want it to appear somewhere in the book, and the "How to Cite" page seemed like the most logical place for it.
Also, as I said over at #604, I am trying to reduce the amount of duplication of author metadata. The
CITATION.cfffile (which is used by GitHub and Zenodo) is now a reproducible product rather than a source of truth.Future changes in the authorship list would be handled in the frontmatter of the one page where we display it. And the author data itself isn't defined in this repo at all, rather it is fetched from our upstream
pythia.yml.