MDN/Archives/Projects/Development/CompatibilityTables: Difference between revisions

From MozillaWiki
< MDN‎ | Archives
Jump to navigation Jump to search
 
(60 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Web compatibility tables (WCT) are one of the key feature of MDN. It allows users to know more about the reliability of any web standard features and to ease the use of web technologies. Currently, the data are gather and maintain "by hand". Thanks to our awesome community we have some good data. However, this is hardly sustainable as the number of technologies is growing as well a the complexity of the implementation. We start to face some difficulties to stay up to date and to provide and improved content around those data.
Web compatibility tables (WCT) are one of the key features of MDN. They allow users to know more about the reliability of any web standard feature and to ease the use of web technologies. Currently, the data is gathered and maintained "by hand". Thanks to our awesome community we have some good data. However, this is hardly sustainable, as the number of technologies is growing as well as the complexity of the implementations. We start to face some difficulties to stay up to date and to provide and improve content regarding this data.


= Goals =
= Goals =
This project intend to cover the following goals:


* Improving the quality and display of data
Long terms goals and how we see the project is elaborated in the '''[[MDN/Projects/Development/CompatibilityTables/Vision|Vision Document]]'''
** Avoid misleading users with inaccurate data.
*** '''NOTE:''' ''This is our primary concern as misleading users is the worst thing we could do on MDN (as a bad side effect it could induce distrust of Mozilla).''
** Make sure our data are coherent all across MDN.
*** '''NOTE:''' ''This is our secondary most important concern for the same reason as the first one (even if the side effect could only affect MDN rather than Mozilla).''
** Allow compatibility data to scale technically with a proper data schema
** Allow simple and complex compatibility data to be properly display in a responsive environment
* Easing data contribution
** Allow (and automate) massive data contribution
** Allow easier single in-site contribution
*** '''NOTE:''' ''This is our third most important concern as it impacts contributors right now. By easing the contribution we ensure to improve both the quality and quantity of data, but we also pleased our contributors which ultimately contribute to the good reputation of both MDN and Mozilla.''
* Easing access to data
** Provide a way to allow third party tools or web sites to use our data
** Allow importation of data from third party resources
* Allowing the reuse of data within MDN
** Make data reachable through KumaScript
** Make data usable for filtering research


'''NOTE:''' ''This project is action driven rather than time driven. It means that we do whatever is needed to reach our goals, whatever the time it requires. However, in order to not to be swamped into an endless project, we try to cut into small actionable steps that allows to measure progress as often as possible.''
== 2016 Planning ==


= Critical Path =
An actionable breakdown is available in the [[MDN/Projects/Development/CompatibilityTables/Milestones|project milestones page]].


To ensure the success of the project, the following schema detailed its critical path in term of actions.
End of year goals:


[[File:Mdn-compat-data.png|628px|thumb|center|Critical path]]
* At the end of the year, browsercompat.org must
** be a standalone data service with its own set of contributors
** have an agile, continuous delivery process
** provide compatibility data both in read and write mode
** have MDN to be its first client
* At the end of the year, MDN must:
** Display better and more reliable browser compatibility data
** Display browser compatibility data in different and more contextual ways
** Display more compatibility data about new browsers/environments
** Provide a smooth contribution pathway to browsercompat.org


It can be roughly summarized as follow:
= Current stats =
# Retrieve the most important needs (requirement and use cases) regarding the data
# Handle a data storage
# Build how to get data
# Build how to expose data


= Get Involved =
Current milestone: [[MDN/Projects/Development/CompatibilityTables/Milestones/Bicycle|Bicycle]] (frozen)
Any one who wish to get involved with this project is welcome. This page will provide information about the project and its progress. Everything is discuss directly on [https://lists.mozilla.org/listinfo/dev-mdn the dev-mdn mailing list]. Schedule and progress are summarized on the [https://lists.mozilla.org/listinfo/mdn-drivers the mdn-drivers mailing list].
Achievement: '''46%'''
 
* [https://docs.google.com/presentation/d/1Ly5B705D4CkMJjQgVGUndBSAPJ7ktbkLZwdr5EaQlGk/edit?usp=sharing Project assessment]
* [https://docs.google.com/spreadsheets/d/1YgUVcvXxY0ocdThTdKzFTwR83OEiP1wF-uet7UjB9dQ/edit?usp=sharing Project dashboard]
* [[MDN/Projects/Development/CompatibilityTables/Milestones|Full milestones breakdown]]
* [[MDN/Development/CompatibilityTables/Infrastructure|Infrastructure]] (target)


[[User:Jeremie Patonnier|Jeremie]] is the resource leading that project, feel free to contact him for any question. He's available, for sure, on IRC every Monday (European time) on the various MDN Chanel (#mdn, #devmo, #mdndev) and more.
Deprecated (to be archived):
* Temporary [https://docs.google.com/document/d/1J8Ip8NjXTcnMcsOg4OWtvWvT1vCgQnMU3_Ug7HB9m64/edit short term plan]
* Next release spec.: [https://docs.google.com/document/d/1J8Ip8NjXTcnMcsOg4OWtvWvT1vCgQnMU3_Ug7HB9m64 BC Skateboard]


= Current progress =
== Meeting minutes ==
Public project meeting occurs every two weeks on Tuesday at [http://arewemeetingyet.com/UTC/2016-01-19/18:00/b/Browser%20Compat%20Project%20Meeting 18:00 UTC] in the [https://v.mozilla.com/flex.html?roomdirect.html&key=gMM1xZxpQgqiQFNkUR3eBuHgxg MDN Vidyo room].


== In progress ==
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-03-15|03/15/2016]]
* Follow up of the project on Bugzilla:
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-03-01|03/01/2016]]
** https://bugzilla.mozilla.org/show_bug.cgi?id=compat-data
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-02-26|02/16/2016]]
* Defining the data schema to use
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-02-02|02/02/2016]]
** https://bugzilla.mozilla.org/show_bug.cgi?id=996570
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-01-19|01/19/2016]]
* [[MDN/Projects/Development/CompatibilityTables/Project_meetings/2016-01-03|01/03/2016]]


== Next step ==
== Bugzilla raw backlog ==
* Start building the data hosting service
* Organize an all-hand monthly meeting to track progression of the project


== Done ==
List of all open bugs for the project. The objective is to reach 0 ''major'' and ''normal'' bugs for milestones other than ''TARDIS''
* [https://groups.google.com/forum/#!topic/mozilla.dev.mdc/idxLWg64PfA Kick off]
* [https://groups.google.com/d/msg/mozilla.dev.mdn/NY4jZf46Kb8/dvhOeAmaMa4J Sort out initial feedback]
* [[MDN/Development/CompatibilityTables/Data Requirements|Functional requirements regarding data]]
* [https://etherpad.mozilla.org/cdp-tech-kick-off-2014-03-28 Technical kick off]
* [https://etherpad.mozilla.org/cd-ux-kick-off UX kick off]


== Bugzilla status ==
Main tracking bug: https://bugzilla.mozilla.org/show_bug.cgi?id=compat-data
Main tracking bug: https://bugzilla.mozilla.org/show_bug.cgi?id=compat-data
<bugzilla>
<bugzilla>
    {
{
        "blocks":"989448",
  "whiteboard": "[bc:",
        "bug_status":"RESOLVED",
  "f1" : "bug_status",
        "bug_status_type":"not_equals",
  "n1" : 1,
        "include_fields": "id, summary, status, assigned_to"
  "o1" : "equals",
    }
  "v1" : "RESOLVED",
  "f2" : "bug_status",
  "n2" : 1,
  "o2" : "equals",
  "v2" : "VERIFIED",
  "include_fields": "id, summary, status, severity, whiteboard"
}
</bugzilla>
</bugzilla>


= Useful resources =
= Get Involved =
Any one who wish to get involved with this project is welcome. This page will provide information about the project and its progress. Everything is discuss directly on [https://lists.mozilla.org/listinfo/dev-mdn the dev-mdn mailing list]. Schedule and progress are summarized on the [https://lists.mozilla.org/listinfo/mdn the mdn mailing list].
 
==Who's in charge?==
 
Responsibilities for the project are define through the following RASCI matrix:
* [[Media:MDN_-_RACI_-_Compat_Data.pdf | MDN — RACI — Compat Data (PDF)]]
 
The main contact points are the following:
* Project Management: [https://mozillians.org/fr/u/Jeremie/ Jeremie Patonnier] (Europe [http://www.timeanddate.com/time/zones/cet CET])
* Dev lead: [https://mozillians.org/fr/u/jwhitlock/ John Whitlock] (US [http://www.timeanddate.com/time/zones/cst CST])
* UX/Front-end lead: [https://mozillians.org/fr/u/stephaniehobson/ Stephanie Hobson] (Canada [http://www.timeanddate.com/time/zones/pst PST])
* Data and MDN content management: [https://developer.mozilla.org/en-US/profiles/Teoli Jean-Yves Perrier] (Europe [http://www.timeanddate.com/time/zones/gmt GMT])
 
== Join the discussion and meet the team ==
 
A public project meeting occurs every two weeks on Tuesday at [http://arewemeetingyet.com/UTC/2016-01-19/18:00/b/Browser%20Compat%20Project%20Meeting 18:00 UTC] in the [https://v.mozilla.com/flex.html?roomdirect.html&key=gMM1xZxpQgqiQFNkUR3eBuHgxg MDN Vidyo room]. Everybody is welcome to attend.
 
Beside the project meeting, everything is discussed on mailing lists:
* [https://lists.mozilla.org/listinfo/dev-mdc dev-mdc]: Functional discussion (Features prioritization, data, content, UX)
* [https://lists.mozilla.org/listinfo/dev-mdn dev-mdn]: Technical discussion (Architecture, QA, Dev work)
* [https://lists.mozilla.org/listinfo/mdn mdn]: Project management discussion (Prioritization, status, decision)
 
On a daily basis, the team members are available for discussion during their respective working hours on [[IRC]]:
* on the #mdn channel (functional).
* on the #mdndev channel (technical).
 
==How to help?==
 
Depending on your skills, this project offers many contribution opportunities:
 
===Development===
 
The data repository is a full Django application, so if you know Python, Django and HTML/CSS/JS you're welcome to help.
 
* [https://github.com/mdn/browsercompat Source code on GitHub]
* [https://browsercompat.readthedocs.org/en/latest/ Browser Compat API documentation]
 
===UX & Design===
 
Displaying and contributing data in a way that makes it understandable and usable by everyone is quite challenging. If you are skilled in design and UX, your help is more than welcome.
 
===Data Management===
 
Our data is currently hosted on MDN itself and we need some help to clean and normalize it and do the transition to our new data repository. If you want us to move faster, this is where your help is needed and it doesn't required any particular skills. :)
 
* [[MDN/Development/CompatibilityTables/Importer|Learn about importer errors]]
* [[MDN/Development/CompatibilityTables/Translation|l10n strategy & tools]]


* Discussion on the WPF ML about using MDN compatibility data
== Tracking tools ==
** http://lists.w3.org/Archives/Public/public-webplatform/2014Jan/0017.html
* Proposal by Daniel Buchner to automated gathering compatibility data
** See https://groups.google.com/forum/#!topic/mozilla.mdn.drivers/qS7InnkaNYY
** and https://bugzilla.mozilla.org/show_bug.cgi?id=946413
* Draft for a data schema by Sheppy, Jean-Yves and Jeremie
** https://etherpad.mozilla.org/MDN-compat-schema
* Draft for a standard data schema by the webplatfrom.org project
** http://webplatform.github.io/browser-compat-model/
* Mockup of a browser support info ribbon that could go at the top of MDN pages, by Chris Mills
** http://people.mozilla.org/~cmills/browser-compat-ribbon/


== Possible third party resources ==
* [http://mzl.la/1P0n4b5 Bugzilla]
* [https://docs.google.com/spreadsheets/d/1YgUVcvXxY0ocdThTdKzFTwR83OEiP1wF-uet7UjB9dQ/edit?usp=sharing Project dashboard]
* [https://trello.com/b/whnNVWBA/compatibility-data-project Project Trello board] (outdated & unmaintained)


=== data source ===
= Archive =
* http://www.browserscope.org
* http://caniuse.com
* http://mobilehtml5.org
* http://html5test.com
* Google Analytics stats (this need further investigation)
* http://www.quirksmode.org/compatibility.html
* http://status.modern.ie/


=== tests suite ===
The project is now two years old and we have some outdated documents that we keep for information purposes, but be aware that they are no longer canonical for the project.


* http://modernizr.com
* [[MDN/Projects/Development/CompatibilityTables/Useful ressources|Useful ressources]]
* https://github.com/w3c/web-platform-tests
* [[MDN/Projects/Development/CompatibilityTables/Project status|Project Status for 2014/2015]]
* https://github.com/operasoftware/presto-testo (this is raw material, but quite interesting)

Latest revision as of 19:47, 19 June 2017

Web compatibility tables (WCT) are one of the key features of MDN. They allow users to know more about the reliability of any web standard feature and to ease the use of web technologies. Currently, the data is gathered and maintained "by hand". Thanks to our awesome community we have some good data. However, this is hardly sustainable, as the number of technologies is growing as well as the complexity of the implementations. We start to face some difficulties to stay up to date and to provide and improve content regarding this data.

Goals

Long terms goals and how we see the project is elaborated in the Vision Document

2016 Planning

An actionable breakdown is available in the project milestones page.

End of year goals:

  • At the end of the year, browsercompat.org must
    • be a standalone data service with its own set of contributors
    • have an agile, continuous delivery process
    • provide compatibility data both in read and write mode
    • have MDN to be its first client
  • At the end of the year, MDN must:
    • Display better and more reliable browser compatibility data
    • Display browser compatibility data in different and more contextual ways
    • Display more compatibility data about new browsers/environments
    • Provide a smooth contribution pathway to browsercompat.org

Current stats

Current milestone: Bicycle (frozen) Achievement: 46%

Deprecated (to be archived):

Meeting minutes

Public project meeting occurs every two weeks on Tuesday at 18:00 UTC in the MDN Vidyo room.

Bugzilla raw backlog

List of all open bugs for the project. The objective is to reach 0 major and normal bugs for milestones other than TARDIS

Main tracking bug: https://bugzilla.mozilla.org/show_bug.cgi?id=compat-data

No results.

0 Total; 0 Open (0%); 0 Resolved (0%); 0 Verified (0%);


Get Involved

Any one who wish to get involved with this project is welcome. This page will provide information about the project and its progress. Everything is discuss directly on the dev-mdn mailing list. Schedule and progress are summarized on the the mdn mailing list.

Who's in charge?

Responsibilities for the project are define through the following RASCI matrix:

The main contact points are the following:

Join the discussion and meet the team

A public project meeting occurs every two weeks on Tuesday at 18:00 UTC in the MDN Vidyo room. Everybody is welcome to attend.

Beside the project meeting, everything is discussed on mailing lists:

  • dev-mdc: Functional discussion (Features prioritization, data, content, UX)
  • dev-mdn: Technical discussion (Architecture, QA, Dev work)
  • mdn: Project management discussion (Prioritization, status, decision)

On a daily basis, the team members are available for discussion during their respective working hours on IRC:

  • on the #mdn channel (functional).
  • on the #mdndev channel (technical).

How to help?

Depending on your skills, this project offers many contribution opportunities:

Development

The data repository is a full Django application, so if you know Python, Django and HTML/CSS/JS you're welcome to help.

UX & Design

Displaying and contributing data in a way that makes it understandable and usable by everyone is quite challenging. If you are skilled in design and UX, your help is more than welcome.

Data Management

Our data is currently hosted on MDN itself and we need some help to clean and normalize it and do the transition to our new data repository. If you want us to move faster, this is where your help is needed and it doesn't required any particular skills. :)

Tracking tools

Archive

The project is now two years old and we have some outdated documents that we keep for information purposes, but be aware that they are no longer canonical for the project.

Retrieved from "https://wiki.allizom.org/index.php?title=MDN/Archives/Projects/Development/CompatibilityTables&oldid=1173952"