[Compat Data] Merge support.note and support.footnote in .footnote

RESOLVED FIXED

Status

Mozilla Developer Network
General
--
enhancement
RESOLVED FIXED
3 years ago
3 years ago

People

(Reporter: jwhitlock, Unassigned)

Tracking

Details

(Whiteboard: [specification][type:feature])

(Reporter)

Description

3 years ago
What problems would this solve?
===============================
The current MDN Browser Compatibility table includes short, inline notes for browser support of a particular feature, as well as longer footnotes that can include code samples and longer narratives.  Removing this distinction will allow better compatibility tables moving forward.

Who would use this?
===================
Developers seeking compatibility information, contributors adding information, and translators localizing the notes.

What would users see?
=====================
Developers will see a quick overview of compatibility across web clients ("Yes", "No", "Partial", w/ Red / Yellow / Green signals), with UI for exposing the detailed notes.  Contributors will get a single notes field for support data.  Localizers will see a single notes field for localization.

What would users do? What would happen as a result?
===================================================
Developers will be able to dive into the detailed notes for implementation details.  Contributors will not need guidance on what is suitable for an inline note vs. a footnote, and will be encouraged to include code samples and links to more information.  Localizers will have one field to localize, and will translate full sentences rather than fragments.

Is there anything else we should know?
======================================
Discussion started on Jan 21 2015 on mdn-drivers [1] and the decision was made on Jan 27 2015 [2]

[1] https://groups.google.com/forum/#!topic/mozilla.mdn.drivers/J9E3_e0S1hA
[2] https://groups.google.com/forum/#!topic/mozilla.mdn.drivers/9dSkT8qVe7E
(Reporter)

Updated

3 years ago
Blocks: 996570
Severity: normal → enhancement

Comment 1

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

https://github.com/mozilla/web-platform-compat/commit/9d7dd8da6ed47b9ba1e48fd62b9154f9af4d5a69
bug 1128519 - Stop using support.footnote

- Remove support.footnote from API
- Import MDN pages into support.note
- Update displays to render support.note as footnote, drop
  support.footnate
- Remove support.footnote from docs
- Remove support.footnote from tools

Also, update docs to use new alabaster theme.

https://github.com/mozilla/web-platform-compat/commit/c965c7a25b08ec465b8eabc57c44726acce0d823
bug 1128519 - Move support.footnote to .note

https://github.com/mozilla/web-platform-compat/commit/facba39f7cc4844d777a215cf2ac4e538b7efdee
fix bug 1128519 - Drop support.footnote

https://github.com/mozilla/web-platform-compat/commit/2abbb6f6d1405c3b115b3c756b3aed80960b411b
Merge pull request #25 from jwhitlock/1128519_merge_support_notes

fix bug 1128519 - Merge support.notes and .footnotes into .notes

Updated

3 years ago
Status: UNCONFIRMED → RESOLVED
Last Resolved: 3 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.