-
Notifications
You must be signed in to change notification settings - Fork 144
O: Event reference docs refactoring #685
Comments
The foundation tasks are written now. I had one API (WebSpeech) to play through a moving. In the MDN leads meetings today we decided that we should put 10 APIs into the next sprint, so I will create 10 issues in a similar fashion like I've done in #915 |
I have created 10 issues for ten groups of events to work on. They are linked above. We have 262 web events and there are 135 events not yet in issues. So these 10 issues are half of the web event pages roughly. Of course there is more work besides moving web events (see foundational work above), so I'm not saying that we can get half of all the work done in one sprint, but I think this would be really great progress. |
A lot of the events listed as “Legacy add‑ons” should be listed as “Chrome code”: #874 (comment) |
If you tell me which, then I can update #874. |
I’m pretty sure it’s all of them. |
Updated. |
I've written up the procedure for moving and updating event reference pages, based on #915 (comment) and other stuff we have learned/decided since then. This comment will be updated as we learn/decide new things :). For each page:
Event page updates
The page structure should be like:
The cells in the first column should be defined using <table class="properties">
<tbody>
<tr>
<th scope="row">Bubbles</th>
<td>Yes</td>
</tr>
<tr>
<th scope="row">Cancelable</th>
<td>No</td>
</tr>
<tr>
<th scope="row">Interface</th>
<td>{{domxref("Event")}}</td>
</tr>
<tr>
<th scope="row">Event handler property</th>
<td><code><a href="/en-US/docs/Web/API/IDBRequest/onerror">onerror</a></code></td>
</tr>
</tbody>
</table>
<h2 id="Specifications">Specifications</h2>
<table class="standard-table">
<tbody>
<tr>
<th scope="col">Specification</th>
<th scope="col">Status</th>
</tr>
<tr>
<td>{{SpecName('SPECNAME', '#SPECFRAGMENT')}}</td>
<td>{{Spec2('SPECNAME')}}</td>
</tr>
</tbody>
</table>
Interface page updates
Some example migrated event pages: https://developer.mozilla.org/en-US/docs/Web/API/IDBRequest/error_event Some example "Events" sections in the interface pages: https://developer.mozilla.org/en-US/docs/Web/API/SpeechRecognition#Events |
I would like for us to seriously consider naming the pages "InterfaceName: eventname event" instead of simply "InterfaceName: eventname" For example, I feel very much that "RTCPeerConnection: track event" is vastly more helpful, and much easier to quickly understand what you're seeing, than simply "RTCPeerConnection: track". Not to mention that we've been getting recommendations from the SEO side that we add things like this to titles anyway. |
I would support that. |
Also, for the blue box ( |
User story
As a MDN content writer or content lead, I want to have a detailed refactoring plan about the event reference docs, so I can fit work items into sprints in Q1 2019.
Acceptance criteria
User stories and tasks for the event docs refactoring are created, estimated and prioritized. (the checklist under "planning tasks" is done)
Planning tasks
The text was updated successfully, but these errors were encountered: