Skip to content
This repository has been archived by the owner on Feb 1, 2023. It is now read-only.

Report UI Design #268

Open
3 tasks done
smth opened this issue Oct 3, 2017 · 11 comments
Open
3 tasks done

Report UI Design #268

smth opened this issue Oct 3, 2017 · 11 comments
Assignees

Comments

@smth
Copy link
Contributor

smth commented Oct 3, 2017

Provide a list of errors/failures for job. Describe nature of error, make it easy to find in original file(s).
Show history of jobs for current source.

  • Design
  • Feedback
  • Mock up
@smth
Copy link
Contributor Author

smth commented Oct 3, 2017

gtio_app_02_report_02

gtio_app_02_report_01_not-logged-in

gtio_app_02_report_01_collapsed

@smth
Copy link
Contributor Author

smth commented Oct 3, 2017

@smth smth added the ui/x label Oct 3, 2017
@smth smth self-assigned this Oct 3, 2017
@smth smth mentioned this issue Oct 3, 2017
20 tasks
@roll
Copy link
Member

roll commented Oct 6, 2017

Report component (part of the picture above with file names and error lists) now lives in the dedicated repository:

It's a very important component because it provides UI for various OKI services:

  • goodtables.io
  • ckan-goodtables (I suppose)
  • OS Packager
  • etc

Because it's a re-usable component we have slightly different tech requirements for CSS e.g. we can't use bootstrap variables and can't directly tweak bootstrap classes (only prefixing with goodtables-ui-report class).

Because we're updating report visual design again I'm wondering is it possible for you @smth to work directly on https://github.com/frictionlessdata/goodtables-ui codebase? It easy to work with and could simplify things.

cc @smth @amercader

PS.
The same for try.goodtables.io Form design - #257

@smth
Copy link
Contributor Author

smth commented Oct 18, 2017

OK, so as a first step, I have extracted the report SCSS (as it stands) into a separate file, and given it its own variables, so it can be more easily tweaked and/or generated outside of Bootstrap.

https://github.com/smth/goodtables/blob/master/assets/scss/goodtables-ui-report.scss

Is this the approach you had in mind?

@smth
Copy link
Contributor Author

smth commented Oct 18, 2017

@roll @amercader what do / can we show in a report that has no errors?

@amercader
Copy link
Member

@smth Maybe show the names of the files validated? Are the headers of these files part of the report @roll ? is it worth showing them?

@roll
Copy link
Member

roll commented Oct 18, 2017

https://github.com/smth/goodtables/blob/master/assets/scss/goodtables-ui-report.scss

Thanks. I think it should solve many problems of goodtables-ui. Are there still some gotchas - I think it will be clear when we'll be updating goodtables-ui to the new design.

@roll
Copy link
Member

roll commented Oct 18, 2017

what do / can we show in a report that has no errors?

I think it's definitely a list of valid file names. What we have also (may be as a click on show more details):

  • file's headers (not sure it's needed to show)
  • file's row count
  • list of successful checks - https://github.com/frictionlessdata/goodtables-py/issues/205 - could be really useful info (definitely hidden by default). List could be like this:
    • Blank Header
    • Missing Value
    • and other 10-20
  • also we have file's scheme, format, encoding
  • we have validation time

@smth
Copy link
Contributor Author

smth commented Oct 23, 2017

OK, I've added a passed file name, as well as the ability to see passed tests for each file: http://p.smth.uk/goodtables/jobs/report/

Do we think this is sufficient?

@roll
Copy link
Member

roll commented Oct 23, 2017

@smth
I think that's great. One comment - the indicator for opened/closed passed checks. Not sure. May be it should be filled with a color when corresponding tab is open? Just I've got a little bit confused with current indication.

@roll
Copy link
Member

roll commented May 20, 2019

DONE

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

No branches or pull requests

3 participants