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

Website updates from hackathon #638

Draft
wants to merge 30 commits into
base: main
Choose a base branch
from

Conversation

dannon
Copy link
Member

@dannon dannon commented Dec 16, 2024

Standing branch for various enhancements from the top block of #629.

Right now working on the general presentation and included details of the landing page workflow listing, pulling in categories, etc.

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

@dannon dannon changed the title Workflow list updates website workflow list updates from hackathon Dec 16, 2024
@dannon dannon added website enhancement New feature or request labels Dec 16, 2024
@dannon dannon marked this pull request as draft December 16, 2024 14:25
dannon and others added 25 commits December 19, 2024 08:18
… care about adding the category to the manifest.
Since we'll have a hero below this, maybe no need for a large masthead?
needs a bit of work to ensure scrolling isn't annoying
more detailed tabs (prioritizing more summary/toplevel info to the left)
@dannon dannon changed the title website workflow list updates from hackathon Website updates from hackathon Dec 19, 2024
@dannon dannon force-pushed the workflow-list-updates branch from 310ed0c to e70ae68 Compare December 19, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants