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

Add Workflow Title and Annotation sections #18762

Merged
merged 26 commits into from
Nov 15, 2024

Conversation

hujambo-dunia
Copy link
Contributor

@hujambo-dunia hujambo-dunia commented Sep 3, 2024

Fixes #18711.

Now, we have two types of views: Run Form version (left) and the Invocation View one (right)

image

Initial Implementations

Visually, there are numerous ambiguous ways to solve this issue.

Version 3 takes into account Marius' comment for simplicity but maintaining consistency with Workflows Landing Page design_.

v3: Expandable Portlet component with site consistency for Workflows Landing Page

demov3_Expandable_Portlet_Site_Consistency_for_Workflows_Landing


Version 2 takes into account Ahmed's comment for consistency with Tool Form page header design.

v2: Expandable Portlet component with site consistency

demov2_Expandable_Portlet_Site_Consistency


Version 1 is illustrated below as an "expandable portlet" solution. Other ideas/possibilities: "Mouse Hover Overlay-Menu", "Mouse Click Overlay-Menu", "Only Display Description", and so forth. After general solution is agreed, will complete "code clean-up" and test script fix process. Constructive ideas/comments welcome.

v1: Expandable Portlet component
demov1_Expandable_Portlet

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@hujambo-dunia hujambo-dunia changed the title New component for Title and Annotation detail Annotation and Title detail Sep 3, 2024
@hujambo-dunia
Copy link
Contributor Author

@ElectronicBlueberry this commit will have negative downstream effects?

@ahmedhamidawan
Copy link
Member

ahmedhamidawan commented Sep 3, 2024

I know this is WIP, but one tiny styling improvement could be made by placing the run and cog button in the same line as the wf name:

image

as opposed to:

image

One way to achieve this would be a <slot> for workflow-run-settings (and the run button) maybe?


On a somewhat related note, I always felt that using the same styled header as a ToolCard for workflows could also look nice?:

image

Kind of like:

image

@hujambo-dunia hujambo-dunia marked this pull request as ready for review September 10, 2024 14:56
@github-actions github-actions bot added this to the 24.2 milestone Sep 10, 2024
Copy link
Member

@mvdbeek mvdbeek left a comment

Choose a reason for hiding this comment

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

Really cool, thank you! But please don't embed the published card there. Just a simple expand would be brilliant.

client/src/components/Workflow/Run/WorkflowRunName.vue Outdated Show resolved Hide resolved
client/src/components/Workflow/Run/WorkflowRunName.vue Outdated Show resolved Hide resolved
@hujambo-dunia
Copy link
Contributor Author

@itisAliRH Wanted your review on changes to the WorkflowCard.vue file in this commit modifies your component to include a show-actions Boolean props

@hujambo-dunia
Copy link
Contributor Author

hujambo-dunia commented Oct 23, 2024

Ahmed: Minor change requests

  1. Backend change in managers/workflow.py: workflow_id: trans.app.security.encode_id(workflow.id) COMPLETE
  2. Create new frontend component based on following but only pull in last 4/right-most actions: WorkflowInvocationHeader.vue
  3. After expandable header, add 2nd secondary component for README.md (check out 3rd party dependency)

@hujambo-dunia hujambo-dunia marked this pull request as draft November 4, 2024 14:45
@hujambo-dunia hujambo-dunia force-pushed the enhance-workflow-detail branch 2 times, most recently from 471ca88 to fa118ba Compare November 5, 2024 15:25
hujambo-dunia and others added 26 commits November 13, 2024 10:51
Co-authored-by: Ahmed Hamid Awan <qe66653@umbc.edu>
…kflows Landing Page (instead of design consistency with Workflows Annotation History Panel). Added 'show-actions' Boolean parameter to focus user on running the workflow as consistent with their intended behavior from the prior step; when 'show-actions' equals False, all actions are hidden (note: not same terminology as technical 'read-only' as 'show-actions' also prohibits Share/Favorite which are separate from being able to Edit a workflow).
Co-authored-by: Marius van den Beek <m.vandenbeek@gmail.com>
Co-authored-by: Marius van den Beek <m.vandenbeek@gmail.com>
- No `in_panel` prop in route anymore
- In `lib/galaxy/managers`, all we need is the `workflow.id` so on the front end, for the run form, we can call `useWorkflowInstance(workflow_id)`
- Adjust props and variables in the workflow header to cater for all edge cases such as whether it is rendering for run form or invocation view, workflow is owned or not, is published or not etc.
- Minor style improvements
The `BButton :to`, was replaced with a `BButton @click` because the styling in `WorkflowNavigationTitle` worked better with a non `<a>` BButton (using `:to` turns the `<button>` into an `<a>`)
We removed the switch/view history button from the workflow run form version of the header, but it actually makes sense to keep it there since it lets the user know which history is going to be the input for the workflow (it changes as you change the history).

In the invocation version of course it always made sense because then it is scoped to the history that was used as input for that invocation.
@dannon dannon merged commit f67dc5c into galaxyproject:dev Nov 15, 2024
53 of 55 checks passed

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggestion to add workflow info to top of workflow run page
6 participants