Skip to content

Conversation

@dannon
Copy link
Member

@dannon dannon commented Nov 5, 2025

Adds structured data to workflow detail pages to improve discoverability in Google Scholar and academic search engines. Each workflow page now includes JSON-LD with DOI, creators (with ORCID), license, keywords, and version information.

This should enable citation tracking and make workflows searchable alongside academic publications, similar to how GTN tutorials appear in Google Scholar.

FOR CONTRIBUTOR:

  • I have read the Adding workflows guidelines
  • License permits unrestricted use (educational + commercial)
  • Please also take note of the reviewer guidelines below to facilitate a smooth review process.

FOR REVIEWERS:

  • .dockstore.yml: file is present and aligned with creator metadata in workflow. ORCID identifiers are strongly encouraged in creator metadata. The .dockstore.yml file is required to run tests
  • Workflow is sufficiently generic to be used with lab data and does not hardcode sample names, reference data and can be run without reading an accompanying tutorial.
  • In workflow: annotation field contains short description of what the workflow does. Should start with This workflow does/runs/performs … xyz … to generate/analyze/etc …
  • In workflow: workflow inputs and outputs have human readable names (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless it is generally understood. Altering input or output labels requires adjusting these labels in the the workflow-tests.yml file as well
  • In workflow: name field should be human readable (spaces are fine, no underscore, dash only where spelling dictates it), no abbreviation unless generally understood
  • Workflow folder: prefer dash (-) over underscore (_), prefer all lowercase. Folder becomes repository in iwc-workflows organization and is included in TRS id
  • Readme explains what workflow does, what are valid inputs and what outputs users can expect. If a tutorial or other resources exist they can be linked. If a similar workflow exists in IWC readme should explain differences with existing workflow and when one might prefer one workflow over another
  • Changelog contains appropriate entries
  • Large files (> 100 KB) are uploaded to zenodo and location urls are used in test file

Adds structured data to workflow detail pages to improve discoverability
in Google Scholar and academic search engines. Each workflow page now
includes JSON-LD with DOI, creators (with ORCID), license, keywords,
and version information.

This should enable citation tracking and make workflows searchable
alongside academic publications, similar to how GTN tutorials appear
in Google Scholar.
Tests verify that workflow pages include valid Schema.org JSON-LD with
required fields like DOI, creators with ORCID, license, and keywords.
@mvdbeek
Copy link
Member

mvdbeek commented Nov 5, 2025

https://scholar.google.com/intl/en/scholar/inclusion.html#indexing says it's meta tags, no mention of json-ld. GTN uses both 🤷

Adds Highwire Press tags for Google Scholar indexing alongside JSON-LD.
Includes required fields (title, authors, date) and optional fields
(DOI, abstract, keywords). Only person creators are listed as authors,
organizations excluded per Google Scholar guidelines.
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.

2 participants