Expanding the API Website

Registered by Michael Hall on 2013-11-04

We now have the first release of the new API website, which provides an incremental improvement over the previous static docs. Now that the foundation is in place, it is time to grow the quantity and quality of API docs in the system, allow for community contributors to add related content and comments, and grow a community around maintaining and contributing to the site's content itself, much like we have for AskUbuntu.com

Blueprint information

Status:
Not started
Approver:
Jono Bacon
Priority:
Undefined
Drafter:
Michael Hall
Direction:
Needs approval
Assignee:
Michael Hall
Definition:
New
Series goal:
Accepted for trusty
Implementation:
Unknown
Milestone target:
None

Related branches

Sprints

Whiteboard

Spec: https://wiki.ubuntu.com/DeveloperNetwork
Project: https://launchpad.net/ubuntu-api-website
Previous Blueprint: https://blueprints.launchpad.net/ubuntu/+spec/appdev-1305-api-website

Live site: http://developer.ubuntu.com/api/qml/sdk-1.0/

Cordova 3.3 officially supports Ubuntu
Will Ubuntu 14.04 support 3.0 or 3.3?

== Things To Do ==

Tie topic+version to a source package version
Investigate adding inter-element navigation to all pages (possibly drop-down on Breadcrumbs)
Add docs generation, conversion and publishing to CI progess

(?)

Work Items

Work items:
Write Scopes documentation import management command: BLOCKED
Write HTML5 documentation import management command: DONE
Write Cordova documentation import management command: DONE
Write Webapps JS documentation import management command: TODO
Figure out how to include images referenced in Qt docs: TODO

This blueprint contains Public information 
Everyone can see this information.