Project

General

Profile

Actions

Feature #21944

closed

Workflow launch includes HTML documentation from the description

Added by Peter Amstutz 8 months ago. Updated 7 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Workbench2
Story points:
-
Release:
Release relationship:
Auto

Description


Files

workflow-launch-description.png (51.6 KB) workflow-launch-description.png Peter Amstutz, 07/01/2024 06:53 PM

Subtasks 1 (0 open1 closed)

Task #22025: Review 21944-work-launch-descriptionResolvedStephen Smith08/16/2024Actions
Actions #2

Updated by Peter Amstutz 8 months ago

  • Description updated (diff)
Actions #3

Updated by Peter Amstutz 8 months ago

  • Subject changed from Workflow launch includes HTML documentation from the description and CWL inputs to Workflow launch includes HTML documentation from the description
Actions #4

Updated by Peter Amstutz 8 months ago

  • Target version changed from Development 2024-08-07 sprint to Development 2024-08-28 sprint
Actions #5

Updated by Peter Amstutz 7 months ago

  • Release set to 70
Actions #7

Updated by Peter Amstutz 7 months ago

  • Status changed from New to In Progress
Actions #8

Updated by Peter Amstutz 7 months ago

  • Target version changed from Development 2024-08-28 sprint to Development 2024-08-07 sprint
Actions #9

Updated by Peter Amstutz 7 months ago

  • Assigned To set to Peter Amstutz
Actions #10

Updated by Peter Amstutz 7 months ago

  • Target version changed from Development 2024-08-07 sprint to Development 2024-08-28 sprint
Actions #11

Updated by Peter Amstutz 7 months ago

21944-work-launch-description @ 7b21bc70083b7cc2ab240d99256ab33ff6471143

developer-run-tests: #4386

  • All agreed upon points are implemented / addressed.
    • now displays the workflow description on the launch page.
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • I didn't make it collapsible as this seemed like it would require setting up a more complicated React component with states than I'm used to dealing with.
  • Code is tested and passing, both automated and manual, what manual testing was done is described
    • updated tests
  • Documentation has been updated.
    • improves ability of workflow authors to provide documentation to end users
  • Behaves appropriately at the intended scale (describe intended scale).
    • no changes to scale
  • Considered backwards and forwards compatibility issues between client and server.
    • n/a
  • Follows our coding standards and GUI style guidelines.
    • uses the theme for the title sizing

I ended up moving the 'description' field (for the individual workflow run) to the 'advanced' section, as it isn't frequently used in my experience. I also decided that the initial idea of putting the title and description between the basic form and the inputs was a bad one, which also led to rearranging the fields slightly.

Actions #12

Updated by Stephen Smith 7 months ago

This lgtm!

Actions #13

Updated by Peter Amstutz 7 months ago

21944-work-launch-description @ 9ae80e98c68259816e536fed4fee7a2609fed097

Formatted description shows up on workflow launch and in the registered Workflow page.

developer-run-tests: #4390

Actions #15

Updated by Stephen Smith 7 months ago

lgtm!

Actions #16

Updated by Peter Amstutz 7 months ago

  • Status changed from In Progress to Resolved
Actions

Also available in: Atom PDF