Skip to content

Render authors from YAML front matter - #552

Draft
lubianat wants to merge 8 commits into
ome:mainfrom
lubianat:rfc_yaml_header
Draft

Render authors from YAML front matter#552
lubianat wants to merge 8 commits into
ome:mainfrom
lubianat:rfc_yaml_header

Conversation

@lubianat

@lubianat lubianat commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

First step towards a system with more automation/standardization for rfc status management.

German-BioImaging/ome-zarr-ideas#54

  • feat: build authors from yaml header
  • test setup for rfc 9 comment 5
grafik

Next steps:

  • Change the metadata for other reviews / comments
  • Build the summary on the RFC main page from the index
  • Build the overall index from the metadata on each page using a decision tree (has comment -> y, etc etc)

maybe some controlled vocabulary for review decisions (approve, minor, major, reject) in the front matter too

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Automated Review URLs

@jo-mueller

jo-mueller commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Might benefit from a template, i.e. for RFCs and comments?

@jo-mueller

Copy link
Copy Markdown
Contributor

Also; it may be worth to drop the affiliations from the rendered text, similar to how it's done at ngff-spec. The reasoning there was, that a person's orcid is likely informative enough about past and present affiliations.

Comment thread rfc/9/comments/5/index.md
Comment thread rfc/9/comments/5/index.md Outdated
affiliation: ilastik
- name: Dominik Kutra
github: k-dominik
orcid: https://orcid.org/0000-0003-4202-3908

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Nitpick (which means, “feel free to ignore” ;) ): It annoys me that the GitHub identifier is a single name, while the ORCID identifier is a URI.

I’d rather have, either all URIs:

github: https://github.com/k-dominik
orcid: https://orcid.org/0000-0003-4202-3908

or all non-URIs:

github: k-dominik
orcid: 0000-0003-4202-3908

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

good suggestion. I'll follow https://github.com/ome/ngff-spec/blob/main/authors.yml and keep only the id

@lubianat

lubianat commented Jul 2, 2026

Copy link
Copy Markdown
Contributor Author

a person's orcid is likely informative enough about past and present affiliations.

in theory, yes, it should. in practice, I need to keep the information provided by the authors on under which affiliation that comment was made.

an example is the rfc 9 / comment 5

Anna Kreshuk - ilastik was the intended affiliation, though that is a project and not an employee, and not listed on https://orcid.org/0000-0003-1334-6388

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.

3 participants