Skip to content

Fixes to layout and tweaks for how to run tab#1012

Merged
mvdbeek merged 6 commits intogalaxyproject:mainfrom
dannon:how-to-run-fixes-and-polish
Oct 31, 2025
Merged

Fixes to layout and tweaks for how to run tab#1012
mvdbeek merged 6 commits intogalaxyproject:mainfrom
dannon:how-to-run-fixes-and-polish

Conversation

@dannon
Copy link
Copy Markdown
Member

@dannon dannon commented Oct 30, 2025

Replaces plain code blocks with a new CodeBlock component that has a copy button with icon. Button has transparent background with gray border and switches between copy/check icons. Code blocks now scroll horizontally instead of breaking the page layout.

Also tweaks styling, adds copy button for easier access to text contents.

image

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

Replaces plain code blocks with a new CodeBlock component that has a copy button with icon. Button has transparent background with gray border and switches between copy/check icons. Code blocks now scroll horizontally instead of breaking the page layout.
Changed grid layout to xl breakpoint and reduced sidebar minimum width to prevent overflow when sidebar is visible but viewport is constrained.
@dannon
Copy link
Copy Markdown
Member Author

dannon commented Oct 30, 2025

Ahh, it's still a little janky in certain situations. I'll iterate on it. Also need to address pre/code embeeded in readmes that have it.

@dannon dannon marked this pull request as ready for review October 30, 2025 16:51
@mvdbeek mvdbeek merged commit a9e0229 into galaxyproject:main Oct 31, 2025
2 checks passed
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