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

OWD project: WebDX web-features mapping #208

Open
6 tasks
Elchi3 opened this issue Aug 14, 2024 · 0 comments
Open
6 tasks

OWD project: WebDX web-features mapping #208

Elchi3 opened this issue Aug 14, 2024 · 0 comments
Assignees
Labels
H2 2024 Projects for July-December 2024

Comments

@Elchi3
Copy link
Member

Elchi3 commented Aug 14, 2024

Problem statement

This project is a continuation of #169. The problem statement has been described previously:

There is currently no consistent way to talk about web platform features as groups of features making it impossible to name a combination of features as a web platform capability.

BCD records compatibility at quite a granular level. It provides data for each individual API, CSS property or HTTP header etc. and often also contains sub features describing more detailed facets of a feature. However, BCD has no concept of groups of features; they stand on their own.

MDN does some grouping but it does so incoherently. One mechanism is https://github.com/mdn/content/blob/main/files/jsondata/GroupData.json which is used by sidebars. It is largely based on how specifications group web platform features.

caniuse.com allows varying granularity. You can record compatibility about a specific feature ("WebP image format"), or an about a group of features ("CSS Grid"). chromestatus.com is similar; its granularity varies a lot, too.

As web developer, depending on where you look for compatibility information, this can lead to confusion. Chromestatus, caniuse and MDN might be talking about the same things, but aren't really. What's included in a group? And what is the support thereof? You might get different answers depending on where you look and this can prevent you from making a decision whether or not to use a web platform capability.

Proposed solutions

The W3C WebDX Community Group has started to define feature-sets, see https://github.com/web-platform-dx/web-features

By creating a common nomenclature for web platform features, feature-set intends to support communication between web developers, browser vendors, standardization bodies, and other ecosystem participants. From Array to Cascade Layers to Offscreen Canvas, feature-set identifies, defines, and categorizes capabilities of the web platform that web developers care about.

Task list

  • Map 3000 keys from the Browser Compat Data project to generate features as defined in the Web Features project. Create the data to contain names, descriptions, support statuses, or links to related data sources and documentation.
  • Review at least 750 keys mapped to features by other contributors (assuming these are available for review).
  • Provide synchronization of browser-compat-data keys between the mdn/browser-compat-data and web-platform-dx/web-features repositories. Contribute source code required to synchronize keys to their respective repositories on GitHub.
  • Provide Google with a monthly report on features added to Web Features for review. Spreadsheet
  • Attend or support project meetings, such as the Web Platform DX Community Group meetings or coordination meetings, averaging not more than 2 hours per month.
  • Perform work on additional Web Feature Set Services as may be agreed by Google and OWD in writing (email sufficient).

Priority assessment

  • Effort: Large, until EOY 2024.
  • Dependencies: BCD, web-features, WebDX.
  • Community enablement: WebDX community
  • Momentum: High
  • Enabling learners: n/a
  • Enabling professionals: n/a
  • Underrepresented topics / Ethical web: n/a
  • Operational necessities: n/a
  • Addressing needs of the web industry: The mapping will be used on MDN, caniuse, tooling, status sites.

More information

Open Web Docs (OWD) is a non-profit collective funded by corporate and individual donations.

This project is funded by Google. See https://opencollective.com/open-web-docs/conversations/google-statement-of-work-n104223-web-features-owd-aug-24-9paw0546

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
H2 2024 Projects for July-December 2024
Projects
None yet
Development

No branches or pull requests

2 participants