Ubuntu platform API documentation

Registered by Michael Hall on 2012-04-24

Identify which APIs need to be documented for application developers and ways in which we can provide these APIs in a developer friendly way

Blueprint information

Status:
Not started
Approver:
Jono Bacon
Priority:
Undefined
Drafter:
None
Direction:
Approved
Assignee:
Michael Hall
Definition:
Approved
Series goal:
Accepted for quantal
Implementation:
Unknown
Milestone target:
milestone icon ubuntu-12.10

Related branches

Sprints

Whiteboard

Current documentation:
http://developer.ubuntu.com/api
https://one.ubuntu.com/developer/
 http://doc.qt.nokia.com/

 Libraries:
libunity
libindicate
libappindicator
libnotify
u1-files
u1-music
u1-db
Qt
glib
GObject
OpenGl (not a direct story for the app developers)
SDL (same as above)
gstreamer (from Qt)
libfolks
DBus (from Qt)
udev
udisks
networkmanager
upower (libsolid)

API Presentation:
http://gdn.ion6.net/admin/ (GObject to Django) (https://github.com/aruiz/GDN)
Database-based
Gives the ability to add comments by users (a la PHP - Qt and MSDN do a good job at that too)
Also to add snippets
Add ability to add examples, visuals and descriptions
Might be an option for Gobject-based docs, but we need Qt as well
An idea might be to have different Django apps for each format
Needs ability to link directly to classes,methods and properties
Link to upstream docs for feedback and bug reporting
Way to test effectiveness and completeness of our docs

Where can we get Qt API docs to parse:
In DITA format from qdoc

Scope:
We'd like to present as many documentation to the d.u.c site
But we have to think about how we involve upstream documenters

(?)

Work Items

Work items:
[mhall119] Setup a local GDN instance for evaluation (https://github.com/aruiz/GDN): DONE
[mhall119] Setup a local RTD instance for evaluation: DONE
[aruiz] Rename the project to be more generic: TODO
[aruiz] Evaluate moving the project to Launchpad: TODO
[mhall119] Assess how much work would be involved in creating a frontend for GDN: DONE
[mhall119] Coordinate frontend work for GDN or RTD: DONE
[mhall119] Investigate adding snippets support to GDN or RTD: DONE
[mhall119] Select system for online API docs (GDN, RTD, etc): DONE
[bzoltan] Create importer/backend for Qt documentation: TODO
[davidc3] Help with GDN front end web work (1): TODO
[dylanmccall] Help with GDN front end web work (2): TODO
[ajmitch] Help with GDN front end web work (3): TODO

This blueprint contains Public information 
Everyone can see this information.