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

Fixes for job metrics Galaxy markdown component. #16994

Merged
merged 1 commit into from
Nov 9, 2023

Conversation

jmchilton
Copy link
Member

So #10121 added back in the title header to the component which is only designed for the dataset details page for an individual dataset - the original Markdown implementation striped out the title of that for a good reason.

The target job might an interesting step of a workflow, a problematic tool, an interesting job - so trying to come up with a title atomically is challenging - the context defines why the data is interested. My thought was therefore to keep the component rendered as simply as possible - since the page or report writer will be the one that has the context for how the component should be titled. This component needs a prefix or preamble from the user to be intelligible and so the big h2 "Job Metrics" is not useful or wanted IMO.

#10121 did correctly preserve the removal of the title for the job parameters component - which was always striped out for an identical reason - so I think this getting added back in was just an oversight.

This PR also removes the AWS and Carbon footprint stuff from the component - they take up a ton of real estate. I think the report author should explicitly add those if they are of interest - but that should be a follow up PR.

Before:

Screenshot 2023-11-08 at 12 02 27 PM

After:

Screenshot 2023-11-08 at 11 52 03 AM

How to test the changes?

(Select all options that apply)

  • Instructions for manual testing are as follows:
    1. Run a job. Create a page. Add the component and select the job. Render the page. See it looks better now.

License

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

So galaxyproject#10121 added back in the title header to the component which is only designed for the dataset details page for an individual dataset - the original implementation striped out the title for that reason.

The target might an interesting step of a workflow, a problematic tool, a complex resulting dataset - so trying to come up with a title automically is a little challenging. My thought was therefore to keep the component rendered as simply as possible - since the page or report writer will be the one that has the context for how the component should be titled. It needs a prefix and so the big h2 "Job Metrics" is not useful or wanted I think.

galaxyproject#10121 did correctly preserve the removal of the title for the job parameters component - so I think this getting added back in was just an oversight.
@jmchilton jmchilton marked this pull request as ready for review November 9, 2023 15:34
@github-actions github-actions bot added this to the 23.2 milestone Nov 9, 2023
@jmchilton jmchilton merged commit ff45b63 into galaxyproject:dev Nov 9, 2023
28 checks passed
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.

2 participants