Not easy to find the uitk api documentation

Bug #1431913 reported by Sebastien Bacher on 2015-03-13
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ubuntu Developer Portal
Medium
Daniel Holbach

Bug Description

Using the website I find it quite frustrating to find the uitk qml api summary

That's what I tried

* start from https://developer.ubuntu.com/en/
* click on "apps"

-> https://developer.ubuntu.com/en/apps/

* click "Check out the Ubuntu SDK " -> https://developer.ubuntu.com/en/apps/sdk/

that has references on
- publishing, https://developer.ubuntu.com/en/publish/
- installing the sdk, https://developer.ubuntu.com/en/start/ubuntu-sdk/installing-the-sdk/
- the sdk tutorial https://developer.ubuntu.com/en/apps/sdk/tutorials/

none of those pages have pointers to the apis

the tutorial describes
- create a project, https://developer.ubuntu.com/en/apps/sdk/tutorials/creating-an-sdk-app-project/
- running an application https://developer.ubuntu.com/en/apps/sdk/tutorials/running-apps-from-the-sdk/

the second one has a "Check out the QML" url to https://developer.ubuntu.com/en/apps/qml/ ... that page still has no reference to the documentation, the "write your first application" do have links to specific components though

It would be useful to have some pointers to https://developer.ubuntu.com/api/qml/sdk-14.04/ for existant developers who just want to browse our apis, maybe in the "Next steps" from https://developer.ubuntu.com/en/apps/qml/ a "Browse the APIs documentation"?

Sebastien Bacher (seb128) wrote :

so in fact the top of the page has

" Apps › QML › Tutorials API Cookbook" and the "API" is what I was looking for, that looks like an indication of where you are currently in the site and it seems like I mentally ignored it as being content when I started reading the page

the html5 equivalent page [1] has a section APIs in the "Next step"

"APIs

And of course, developers need the API Reference docs for HTML5/JavaScript. These provide the implementation-level detail you need make your HTML5 apps use the full sweet of platform APIs ."

I would suggest doing the same here

[1] https://developer.ubuntu.com/en/apps/html-5/

Daniel Holbach (dholbach) wrote :

Added a link to the API docs on https://developer.ubuntu.com/en/apps/qml/

Changed in developer-ubuntu-com:
assignee: nobody → Daniel Holbach (dholbach)
importance: Undecided → Medium
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers