metadata view: introduce a minimal task metadata view #1886
Conversation
|
Ping @ScottWales @ColemanTom (you were wanting this for viewing prerequisites etc.) |
|
Great! thanks for this |
oliver-sanders
force-pushed
the
metadata-view-template
branch
from
2e5c1b5
to
d6d9e10
Compare
|
Added offline-data and tests. Many, many enhancements and features left to add to this view, but will leave it at basic metadata, prereqs and outputs for this PR. The main work here is getting the template for the view in place (it's quite different to other views). Further enhancements will slot into this template fairly easily provided the required data is present (and accurate) in the schema. |
* Bare bones task metadata view. * Display task metadata, prerequisites and outputs. * Support for viewing task configuration, broadcasts, etc to follow in future PRs. * Support for markup (e.g. markdown & reStructured text) to arrive in future PRs (pending a decision on how to configure the markup language).
* Added offline data. * Added component tests to cover component display. * Added e2e test to cover opening view, expansion state and data provision.
oliver-sanders
force-pushed
the
metadata-view-template
branch
from
d6d9e10
to
cfbc4a9
Compare
| v-model="panelExpansionModel" | ||
| > | ||
| <!-- The metadata --> | ||
| <v-expansion-panel class="metadata-panel"> |
There was a problem hiding this comment.
IMO most users will be coming here for the pre-reqs and outputs and not the metadata - these should go first and probably not be collapsed.
Could they go in neighbouring Columns?
Happy to spin this out into an issue and not block this PR.
e.g.:
| Prerequisites | | Outputs |
| list of | task icon | |
------------------------------------------------
| Metadata |
There was a problem hiding this comment.
Columns aren't an option (or at least aren't always an option) because they won't work in narrow widths.
We can't expand all of the sections by default as there will be a lot of them, from prerequisites, to completion expression satisfaction, to runtime configuration and broadcasts. Prereqs are important, but so are all the other sections.
We could start with nothing expanded, but I thought the title, description and URL (often used to link to documentation) are notably important and deserve to be displayed at all times. Important messages like "do not re-run this task" or "if it fails, try re-running in shortstep mode" will be prominent as a result.
* Remove the "c" prefix from prerequisite expressions and task aliases. * This matches `cylc show`.
|
|
||
| <!-- The prereqs --> | ||
| <v-expansion-panel class="prerequisites-panel"> | ||
| <v-expansion-panel-title color="blue-grey-lighten-2"> |
There was a problem hiding this comment.
This one is inconsistent with the others
| <v-expansion-panel-title color="blue-grey-lighten-2"> | |
| <v-expansion-panel-title color="blue-grey-lighten-1"> |
There was a problem hiding this comment.
On purpose.
There will be other sections in the near future. I tried adding a few extras and it ended up as a giant block of "blue-grey" which didn't make it especially obvious that these are individual sections that can be expanded.
I thought it was clearer if the sections were striped ("lighten-1", "lighten-2", "lighten-1", ...).
There was a problem hiding this comment.
To me it doesn't really indicate clickability, it looks like it's selected or has keyboard focus or something. Not too important
Co-authored-by: Tim Pillinger <[email protected]> Co-authored-by: Ronnie Dutta <[email protected]>
| } | ||
| }, | ||
|
|
||
| computed: { |
There was a problem hiding this comment.
(Funny, now that I am used to using setup composition API, having separate sections for computed, methods etc seems rather arbitrary)
|
Unfortunately, this work may be blocked by cylc/cylc-flow#6307 which also imposes some back-compatibility constraints :( I can hack it for |
|
|
||
| // prefixes a tick or cross before the entry | ||
| .condition:before { | ||
| content: '☐'; |
There was a problem hiding this comment.
Had a little play about - I like
mdiProgressHelperas an icon to indicate outputs that haven't been completed yet
There was a problem hiding this comment.
Reasonable, might be tempting to do it with native unicode though?
I had changed to content; ' ' locally.
|
We could overcome the block by moving from a delta subscription to a regular subscription. However, this would request the complete data for the task on every change which would get expensive. |
|
|
||
| // for user-defined text where whitespace should be preserved | ||
| .markup { | ||
| white-space: pre; |
There was a problem hiding this comment.
To allow to text to wrap instead of overflowing
| white-space: pre; | |
| white-space: pre-wrap; |
Addresses #582
Check List
CONTRIBUTING.mdand added my name as a Code Contributor.setup.cfg(andconda-environment.ymlif present).?.?.xbranch.