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

Workflow reporting - support for expandable sections, table of contents, multitabs etc. #15088

Open
kciy opened this issue Nov 30, 2022 · 8 comments

Comments

@kciy
Copy link

kciy commented Nov 30, 2022

Using workflow reports makes sense with markdown to have headings and lists, but it could easily extended to allowing HTML as well. This would allow for custom elements, overview tables and more.

It could also help in some things mentioned in #11426

The markdown parser which is used (npm markdown-it) per default disables HTML usage.

Any opinions on this?

@hexylena
Copy link
Member

Unless we're careful about sanitising the resulting report (confusing for users), or using a separate domain for user generated content like this (completely unimplemented, with a long timeline), it potentially increases the attack surface considerably. Everyone would need to be careful when opening a workflow report from someone else.

If it's possible to enumerate which features? there's probably more interest in adding support for those useful subset, rather than allowing any html and the associated attacks possible with that.

@kciy
Copy link
Author

kciy commented Nov 30, 2022

That's true, I see your point.

I would like to have:

  • expandable sections (like with <details><summary>...</details>)
  • an overview table of the report content (I produce rather lengthy reports and links to the headings would make it easier to navigate; I haven't tried using plain markdown yet for this)
  • having multiple reports side-by-side (like minipages), but this could be covered with the point in your issue regarding tabs/multiple pages.

I guess we can close the issue since I agree not just allowing any HTML.

@hexylena
Copy link
Member

those are great suggestions! I'd love a details/summary box as well, and a table of contents, especially for larger reports, would be really nice.

hopefully the updated scratch book works nicely with reports? side by side is exactly the use case for that

@kciy
Copy link
Author

kciy commented Nov 30, 2022

That sounds good, how can we proceed from here?
And what do you mean by scratch book?

@wm75
Copy link
Contributor

wm75 commented Nov 30, 2022

image

It's what seems to be now called the window manager, which allows you to open multiple dataset views at once.

@wm75
Copy link
Contributor

wm75 commented Nov 30, 2022

and, yes, all really good ideas @kciy :)

@kciy
Copy link
Author

kciy commented Nov 30, 2022

Ahaa, thanks!!

@kciy kciy closed this as completed Nov 30, 2022
@nsoranzo
Copy link
Member

I think we want to keep track of these ideas, so maybe keep it open and change the title?

@kciy kciy reopened this Nov 30, 2022
@kciy kciy changed the title Support HTML in Workflow Reports Markdown Workflow reporting - support for expandable sections, table of contents, multitabs etc. Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants