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

Add a Lesson Credit page #238

Closed
tobyhodges opened this issue Feb 1, 2022 · 4 comments
Closed

Add a Lesson Credit page #238

tobyhodges opened this issue Feb 1, 2022 · 4 comments
Assignees
Labels
enhancement New feature or request

Comments

@tobyhodges
Copy link
Member

A page to list the contributors to a lesson, the Maintainers, supporting institutions/funding bodies, etc. The exact nature of this is likely to be heavily informed by discussions in the Lesson Publication Task Force.

@zkamvar zkamvar added the enhancement New feature or request label Feb 1, 2022
@zkamvar zkamvar self-assigned this Jun 27, 2022
@zkamvar
Copy link
Contributor

zkamvar commented Jun 27, 2022

Thinking about this particular issue and the reason why I haven't yet started on it is due to scope:

The scope for the Lesson Publication Task Force:

  • time-bound: this happens for each lesson release cycle
  • maintainers and authors only (funders/institutions are not considered in this)
  • deployed to Zenodo for archiving

The scope for this page:

  • dynamic (this is updated as the lesson grows)
  • maintainers, authors, contributors, and funders/institutions
  • remains editable and portable with the lesson

I think the thing I keep getting stuck on is the fact that we don't have a single way to credit authors dynamically. The LPTF has recommended solutions that rely heavily on processes that have not yet been set up and require extra development time to do so. Moreover, because the authors are needed for the lesson release, we need to make sure that we do not duplicate effort for the maintainers to maintain an author list in more than one place.

One solution I'm thinking of is to create a function that will auto-generate the author list from a well-defined author list mechanism (e.g. a cff file, an all-contributors config file, a DESCRIPTION file, and whatever we come up with for the LPTF) and use that to insert the author list in the lesson itself.

@apirogov
Copy link

apirogov commented Sep 1, 2023

Just FYI, in CFF (see mentioned issue) there are already plans for granular contributor roles for the next version of the format. Possibly of interest in this context:

citation-file-format/citation-file-format#112 (comment)

@tobyhodges
Copy link
Member Author

Thanks @apirogov, very much so. In fact, and inspired by the issue you opened on carpentries/workbench, I was browsing exactly that discussion on the CFF repo yesterday. Support for contributor roles in CFF would probably remove one of the biggest headaches we have at the moment: how to distinguish (in a maachine-readable way) lesson maintainers and reviewers from everyone else who should be listed as an author?

@ErinBecker
Copy link
Contributor

Closed with carpentries/varnish#122

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants