Confirmed users, Bureaucrats and Sysops emeriti
1,057
edits
WebAPI/Docs schedule: Difference between revisions
no edit summary
(first checkpoint save) |
No edit summary |
||
| Line 4: | Line 4: | ||
==Phase 1: Basic Coverage for All APIs== | ==Phase 1: Basic Coverage for All APIs== | ||
The first phase involves having basic content | The first phase involves having basic content with a brief summary for each API, as well as complete reference material for all of the APIs not already documented. This phase should be completed '''by the end of April'''. | ||
Outline of the order in which writing will be done, and estimates for completion dates per API. | Outline of the order in which writing will be done, and estimates for completion dates per API. | ||
| Line 36: | Line 36: | ||
|WiFi Information API||???||''Depends on the implementation status, which is not currently known.'' | |WiFi Information API||???||''Depends on the implementation status, which is not currently known.'' | ||
|} | |} | ||
==Phase 2: Full documentation for all content-accessible APIs== | |||
The next phase is to fully-document all APIs accessible from unprivileged apps. This means having complete how-to documentation, as well as examples. These should be finished by the end of May. | |||
'''Note:''' The contractor doing the majority of the writing is on PTO from April 29 to May 13. | |||
{| cellpadding="2" border="1" | |||
!API!!Estimated completion date!!Notes | |||
|- | |||
|Ambient Light Events||April 27||Nearly finished already. ''Planning to work on this during the Vancouver doc sprint.'' | |||
|- | |||
|Proximity Events||May 15/16|| | |||
|- | |||
|Screen Orientation||May 22/23|| | |||
|- | |||
|Battery Status||May 23/24||Nearly finished already. | |||
|- | |||
|Alarm API||May 24||Nearly finished already. | |||
|- | |||
|Time/Clock API||May 29/30|| | |||
|- | |||
|WebFM API||May 30/31|| | |||
|} | |||
==Phase 3: Full documentation for all Certified APIs== | |||
By the end of June, we should have complete documentation for all '''stable''' certified APIs. | |||
{| cellpadding="2" border="1" | |||
!API!!Estimated completion date!!Notes | |||
|- | |||
|Device Storage API||June 5/6|| | |||
|- | |||
|TCP Socket API||June 6/7|| | |||
|- | |||
|Browser API||June 12/14|| | |||
|- | |||
|Contacts API||June 19/21|| | |||
|- | |||
|WebSMS||June 26||We have fairly good documentation here, so this will be a clean up and enhancement round. | |||
|- | |||
|WebTelephony||June 26||We have fairly good documentation here, so this will be a clean up and enhancement round. | |||
|- | |||
|Settings API||June 26|| | |||
|- | |||
|Web Bluetooth API||June 27/28|| | |||
)} | |||
At this point, our contractor's contract will expire, and what happens from there out is theoretical, but we are in good shape if we hold to this schedule. | |||
==Phase 4: In-depth tutorials== | |||
Once basic documentation is complete by the end of June, we would like to proceed to write more in-depth tutorials for the most important APIs, as well as to show better how to use them together, as well as in concert with Firefox OS UX building blocks as appropriate. | |||
However, we do not currently have resources allocated for this work. That said, we hope to hire a writer in time to have them do this work. | |||