Skip to content

Bioschemas lesson metadata integrated to lesson.html - #344

Open
samumantha wants to merge 8 commits into
mainfrom
bioschemas
Open

Bioschemas lesson metadata integrated to lesson.html #344
samumantha wants to merge 8 commits into
mainfrom
bioschemas

Conversation

@samumantha

@samumantha samumantha commented Jul 27, 2026

Copy link
Copy Markdown
Member
  • adds sphinx-bioschemas extension to sphinx workflow
  • adds bioshemas.yml with lesson metadata from CITATION.cff (script exists but not added; could become another action later to only maintain one metadata file) and lesson itself
  • combine license and reuse info into reuse.md under "about" instead of link to webpage; this reusing page also links to raw citation.cff and Bioschemas.yml file.

I have tested the general workflow and build locally. Slight uncertainty if it's in the right place in sphinx.yml. Please check :)

This is the test lesson for this implementation. If it looks good we can implement for other lessons too.

@rkdarst rkdarst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it looks good to me! This is how I would do it. It seems like such a simple but useful idea.

Comment thread .github/workflows/sphinx.yml Outdated
Co-authored-by: Richard Darst <rkd@zgib.net>
@bast

bast commented Jul 29, 2026

Copy link
Copy Markdown
Member

I am reviewing bioschemas.yml and reusing.md.

@bast

bast commented Jul 29, 2026

Copy link
Copy Markdown
Member

In reusing.md, I would move "How to cite this lesson" and "Structured metadata" above "Website template" and "Instruction material".

Reason: Many people have seen CC-BY legal text and they might stop reading further and miss the part where we recommend how to cite and how to use the metadata.

@bast

bast commented Jul 29, 2026

Copy link
Copy Markdown
Member

bioschemas.yml looks to me consistent with CITATION.cff. I haven't verified that bioschemas.yml validates its schema.

@samumantha

Copy link
Copy Markdown
Member Author

In reusing.md, I would move "How to cite this lesson" and "Structured metadata" above "Website template" and "Instruction material".

Reason: Many people have seen CC-BY legal text and they might stop reading further and miss the part where we recommend how to cite and how to use the metadata.

Good point! Agree, I'll update tomorrow ⚒️

@samumantha

samumantha commented Jul 30, 2026

Copy link
Copy Markdown
Member Author

Done.

@samumantha

Copy link
Copy Markdown
Member Author

The metadata does not change that often. I think metadata update could be up to maintainers instead of making it a separate action?
What do you think?

@bast

bast commented Jul 30, 2026

Copy link
Copy Markdown
Member

The metadata does not change that often. I think metadata update could be up to maintainers instead of making it a separate action? What do you think?

sounds good

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