1154349 - [Compat Data] Improve readability/helpfulness of compat data importer output

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: General, enhancement)

Description

[Eric Shepherd [:sheppy]]

The output of the compat data importer is currently very difficult to read unless you understand the underlying PEG. While we can approach this by simply educating writers on reading these messages, that will limit the number of people that will be able to realistically contribute to the cleanup and update project for MDN's content compatibility with the importer.

Messages should be more easily understood by non-experts. Perhaps we include links in the output to wiki pages that we can put details on how to deal with that problem.

Ideally, we should be able to give the writing community a link to the importer's output and ask people to find things to fix. They should then be able to do so without having to ask for help with interpreting the messages, which means more contributors to the effort.

Comment 1

[Luke Crouch [:groovecoder]]

In our 2015-04-21 meeting we decided to create unique IDs for error messages and to make them links to pages on wiki.mozilla.org. That way we can crowd-source explanations of the errors and how to fix them.

Comment 2

[John Whitlock [:jwhitlock]]

I don't have page creation permissions on wiki.mozilla.org.  Can someone create https://wiki.mozilla.org/MDN/Development/CompatibilityTables/Importer ? needinfo'ing sheppy, who seems most likely to have permission or bounce to the right person.

Comment 3

[Justin Crawford [:hoosteeno] [:jcrawford]]

I created that page.

Comment 4

[John Whitlock [:jwhitlock]]

https://wiki.mozilla.org/MDN/Development/CompatibilityTables/Importer is up and has gotten some staff contributions.  Calling this done.  If more work is needed, please file a targeted bug blocking bug 996570 and with the prefix "[Compat Data][Importer]"

Comment 5

[MDN Team (:mdn-dev)]

Commits pushed to master at https://github.com/mozilla/web-platform-compat

https://github.com/mozilla/web-platform-compat/commit/805007f4775426c98383f713904d3b50427d5e2e
bug 1154349 - Add idents to import issues

Issues are collected in a new model, with:
- A slug to identify similar issues,
- The start and end position in the MDN page
- A dictionary of context data

The slugs are also used to lookup:
- Issue severity:
  - Warning: probably does not impact importing
  - Error: data is present but not imported
  - Critical: unable to finish importing page
- Short and long description templates, using the per-issue context
  data.
- User-contributed content-fixing hints on:

https://wiki.mozilla.org/MDN/Development/CompatibilityTables/Importer

The parse output has been changed. meta.scrape.raw.issues now contains
both the original issues (now Warnings) and errors (Error and Critical).
The HTML description no longer appears in the meta section, but is
generated at display time.

Finally, the importer list shows a count of Warnings / Error / Critical
instead of the binary has / doesn't have errors.

https://github.com/mozilla/web-platform-compat/commit/c067f1a1b9c3c5d366b0c8f0e8b924453b3dd5c4
bug 1154349 - Moar speeling fixes

https://github.com/mozilla/web-platform-compat/commit/677d6a949b84dcbd25b89e7272d85bab359c5d6d
bug 1154349 - Better non-ascii handling

Consistantly use text_type, so that pages like
https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant
will import correctly.

https://github.com/mozilla/web-platform-compat/commit/600bc0a861298673bad00165140d159a62d3b4e9
bug 1154349 - Allow MDN import w/ warnings

Add the "Commit" button when no errors or critical errors are found on
the page.

https://github.com/mozilla/web-platform-compat/commit/fa53c7703d96b741fd5f0a2a04a7d57a6cbe0d58
bug 1154349 - Fix link to view_features endpoint

https://github.com/mozilla/web-platform-compat/commit/00a57f4ef363368c75071341e801e30cb3aa0ec3
bug 1154349 - Fix canonical feature scrape

Canonical features loaded from the database had the name
{'zxx': 'name'}, exposing the internal implementation and breaking the
display. Fixed so name is 'name' instead.

https://github.com/mozilla/web-platform-compat/commit/09bab0f91e1dc0fb0ebaf4f2a7227c9d107d7bd9
bug 1154349 - Update tools/gather_import_issues.py

* Rename tools/gather_import_errors.py
* Use new 'issues' terminology and endpoints
* During import, count up to 100% rather than down to 0%
* Write CSV with new data fields

https://github.com/mozilla/web-platform-compat/commit/d144ee91121a9765f740e77e2abd643bc56d9aac
bug 1154349 - Add issues summary page

https://github.com/mozilla/web-platform-compat/commit/8e0d361b03df881b8716cad68f38ea18b8a3d5b4
fix bug 1154349 - Intentional file reads

It appears TravisCI is now using 'ascii' as their default system
encoding, causing reads of UTF-8 files to fail.  Use io.open with
explicit encoding to fix.

https://github.com/mozilla/web-platform-compat/commit/1788e5c69b6e1f479c8c2b715816c46f693c2387
Merge pull request #29 from jwhitlock/1154349_importer_issues

Fix bug 1154349 - Refactor importer issues

Comment 6

[MDN Team (:mdn-dev)]

Commit pushed to master at https://github.com/mozilla/web-platform-compat

https://github.com/mozilla/web-platform-compat/commit/1bc5d5480d72645de3e85ac5234f7261c4aab604
bug 1154349 - Counts in gather_import_issues.py

gather_import_issues.py was counting end position, not issues.