ropensci / roweb3

rOpenSci website source
https://ropensci.org
20 stars 54 forks source link

Can one credit editors of posts on Rogue Scholar #767

Open maelle opened 5 months ago

maelle commented 5 months ago

:wave: @mfenner!

We've started crediting editors of blog posts using an "editor" YAML field. The editor(s) then appear(s) near the author(s): https://ropensci.org/blog/2024/05/17/communication-tips-oss-project/

Would such metadata have its place in the feed that Rogue Scholar uses?

mfenner commented 5 months ago

Crossref metadata (used by Rogue Scholar for DOI registration) support the "editor" role. Crossref plans to support CRediT, which I would be happy to support in Rogue Scholar once available.

RSS, Atom or JSON Feed don't support the concept of contributor roles. There are two possible solutions, similar to what we discussed with unsupported metadata before: a) custom extensions for JSON Feed, or b) extract the metadata from the full-text.

@maelle are you interested in other contributor roles besides "editor" (not part of CRediT)?

maelle commented 5 months ago

Thank you @mfenner!! At the moment I can't think of other roles. @yabellini @steffilazerte @mpadge do you think we'd need other new roles than editors for blog posts?

mfenner commented 5 months ago

@maelle here are the roles that commonmeta currently supports, from CRediT, DataCite and Crossref: https://github.com/commonmeta/commonmeta.org/blob/main/docs/commonmeta_v0.14.json#L417-L461

steffilazerte commented 5 months ago

I can't think of anything other than Editor, thanks!

mfenner commented 5 months ago

OK. I would suggest a roles property in the blog post yaml that currently can be either author or editor but other science blogs might need other roles. How to send this information to Rogue Scholar we can discuss, one way would custom JSON Feed metadata.

maelle commented 1 month ago

If I try and add editors data (for posts who have the info), what JSON field should I use to start with? Thank you and sorry for the delay.

mfenner commented 1 month ago

This is not specified in JSON Feed (or RSS, Atom), so a custom extension starting with an underscore makes sense. For example (for your next to last post, based on your front matter):

"authors":[{
  "name":"Collin Schwantes",
  "url":"https://orcid.org/0000-0002-9882-941X",
  "_role": "author",
  "avatar":"https://github.com/collinschwantes.png"
},
{
  "name": "Yanina Bellini Saibene",
  "url": "https://orcid.org/0000-0002-4522-7466",
  "_role": "editor"
},{
  "name": "Mark Padgham",
  "_role": "editor"
}],

I assume that capitalization doesn't matter, so either "author" or "Author". "author" would be the default role if _role isn't specified. In the future, other roles might be of interest.

maelle commented 1 month ago

see https://github.com/ropensci/roweb3/pull/863