Views

Documentation Backlog for MeeGo 1.2

From MeeGo wiki

(Difference between revisions)

Latest revision as of 10:31, 12 April 2012

1 Contents of this page
2 Developer documentation
3 Documentation Bugs
4 Features postponed to a later release
- 4.1 Netbook UX guidelines

Contents of this page

This site is used for mapping documentation content areas for the MeeGo 1.2 SDK developer documentation release. Eventually, the page will contain links to all relevant MeeGo 1.2 developer documentation content in wiki and to the developer documentation related features in Bugzilla.

Please be patient while the content on this page is being updated.

Note that this page will not link to any other documentation, such as

instructions about writing documentation
platform development instructions
process descriptions describing how MeeGo OS work is carried out

If you are currently working on draft material for MeeGo 1.2, add links to all the pages you are updating here. Mark the status as: Not started, ongoing, to be reviewed, ready.

The backlog also includes priority information. Priorities are: 1 must-have, 2 useful, 3 optional

Developer documentation

Area owners: Marianne Vaiciulis, Taru Laine

Status: Ongoing.

Link to MeeGo Wiki: Table of Contents for MeeGo 1.2 SDK developer documentation

Link to related feature in Bugzilla: Feature 9479

Getting started

Release notes for MeeGo 1.2 SDK

Area owners: Veli Kaksonen, Bob Spencer

Priority: 1

Suggested location: developer.meego.com (DMC), References/Release notes

Status: Done.

Link to MeeGo Wiki:

will probably be also published in meego.com, in MeeGo release notes

Link to related feature in Bugzilla: Feature 12461

Download site for MeeGo 1.2 SDK

Area owners: Bob Spencer, Veli Kaksonen

Priority: 1

Suggested location: developer.meego.com (DMC), SDK & Tools/SDK

Status: Done

Link to MeeGo Wiki:

probably provided through meego.com

Link to related feature in Bugzilla: Feature 12788

Getting started with MeeGo application development

Area owners: Ronan MacLaverty

Priority: 1

Suggested location: developer.meego.com (DMC), Guides/Getting started

Status: Not started

Links to MeeGo Wiki:

//Having both of these seems redundant, so perhaps they can be merged, like here at developer.meego.com. //

Link to related feature in Bugzilla: Feature 9480

Installation instructions (OBS)

Area owners: TBD

Priority: 2

Suggested location: developer.meego.com (DMC), Guides

Status: Not started

Link to MeeGo Wiki: //to be added//

Link to related feature in Bugzilla: Feature 9481

Installation instructions (application SDK)

Area owner in Bugzilla: Bob Spencer

Priority: 1

Content area owners

Supported guest operating system: Bob Spencer
Installing and configuring MeeGo SDK for Linux: Elliot Smith
Checking your system's graphics capabilities: Bob Spencer
Installing and configuring MeeGo SDK for Windows: Max Yu
Setting up the emulator: Elliot Smith

Suggested location: developer.meego.com (DMC), Guides or SDK tools

Status: Ongoing.

Link to MeeGo Wiki:

Supported guest operating systems
Installing and configuring MeeGo SDK for Linux DONE -- Elliot Smith 08:35, 20 May 2011 (UTC)
Checking your system's graphics capabilities DONE -- Elliot Smith 08:36, 20 May 2011 (UTC)
NB Max has told me that this page Installing and configuring MeeGo SDK for Windows is obsolete; the proper instructions are at SDK/Docs/1.2/MeeGo_SDK_1.2_Preview_for_Windows, but they are very sparse; I've asked Max what he plans to do with these two pages, and I'll review the result -- Elliot Smith 11:15, 4 May 2011 (UTC)
Setting up the emulator DONE -- Elliot Smith 10:08, 20 May 2011 (UTC)

Link to related feature in Bugzilla: Feature 9482

Device provisioning instructions

Area owner in Bugzilla: David Lawlor, Elliot Smith

Priority: Handset and tablet: 1, Netbook: 2

Content area owners

Setting up your handset: Azadeh Karimian
Setting up your netbook: Elliot Smith (already started this, happy to continue)
Setting up your tablet: Kerry Jiang

Suggested location: developer.meego.com (DMC), Guides

Status: Not started

Link to MeeGo Wiki:

Setting up your handset
Setting up your netbook DONE -- Elliot Smith 10:22, 24 May 2011 (UTC)
Setting up your tablet

Link to related feature in Bugzilla: Feature 9483

Developing with MeeGo SDK

Best practices documentation for MeeGo 1.2 SDK

Area owners: TBD

Priority: 3

Suggested location: developer.meego.com (DMC), Guides/Guidelines

Changes since MeeGo 1.1 SDK: New content area.

Status: Postponed to a later release?

Content is being created in a separate wiki on the following topics:

Selecting the resource application class
Optimising power management
Performance management
Designing for performance
Optimising inter-process communications
Coding for performance
Optimising performance for OpenGL applications
Performance testing tools (depends on the available tools)

Link to MeeGo Wiki: Draft content is being created in a separate wiki.

Link to related feature in Bugzilla: Feature 12464

Creating a Hello world application

Area owners: David Lawlor

Priority: 1

Suggested location: developer.meego.com (DMC), Guides

Status: In process.

Link to MeeGo Wiki:

Creating and running your first application

Link to related feature in Bugzilla: Feature 15310

Debugging instructions for MeeGo 1.2 SDK

Area owners: Elliot Smith

Priority: 2

Suggested location: developer.meego.com (DMC), Guides

Status: DONE -- Elliot Smith 12:35, 24 May 2011 (UTC)

Link to MeeGo Wiki:

Debugging with Qt Creator

Link to related feature in Bugzilla: Feature 15308

Instructions for building MeeGo image/QEMU image

Area owners: Zhiyuan Lv

Priority: 3

Suggested location: wiki.meego.com

Status: Not started.

Link to MeeGo Wiki: //to be added//

Link to related feature in Bugzilla: Feature 15307

Packaging instructions (OBS)

Area owners: Elliot Smith

Priority: 2

Suggested location: wiki.meego.com

Status: Not started

Link to MeeGo Wiki: //This content can probably be used as the starting point for MeeGo 1.2: Packaging tutorial for MeeGo 1.0//

Open issues:

How do you upload source code tarball to community OBS (via OSC and/or web interface), along with metadata files, and build MeeGo RPMs for multiple architectures?

Link to related feature in Bugzilla: Feature 9484

Packaging instructions (Application SDK)

Area owners: Mats Wichmann (John Chen)

Priority: 2

Suggested location: developer.meego.com (DMC), Guides

Status: Not started

Link to MeeGo Wiki:

Is it enough if this is mentioned in Creating and running your first application and there is a link to MeeGo packaging guidelines?
There is also an article on creating a package for appup which could possibly be co-opted/converted: http://appdeveloper.intel.com/en-us/blog/2011/03/30/how-integrate-appup-sdk-and-create-rpm-package-meego-applications

Open questions:

How do you deploy your application?
Are there additional steps in Qt Creator that need to be documented?

Link to related feature in Bugzilla: Feature 9485

Troubleshooting information for MeeGo 1.2 SDK

Area owners: TBD

Priority: 2

Suggested location: developer.meego.com (DMC), Guides/FAQ or wiki.meego.com

Status: Ongoing. Content transferred from MeeGo 1.1 SDK developer library, needs to be updated for MeeGo 1.2 SDK.

Link to MeeGo Wiki:

Troubleshooting

Link to related feature in Bugzilla: Feature 12462

Publishing instructions

Area owners: Bob Spencer

Priority: 1

Suggested location: developer.meego.com (DMC), Guides

Status: Initial content with summary and links to currently open or planned vendor developer areas (where more instructions can be found). Also link to open-source repository apps.meego.com (work in progress).

Link to MeeGo Wiki: SDK/Docs/1.2/Publishing

Link to related feature in Bugzilla: Feature 9486

Developing with Xephyr

Area owners: Haito Feng

Priority: 2

Suggested location: developer.meego.com (DMC)

Status: Not started.

Link to MeeGo Wiki:

Developing with Xephyr

Link to related feature in Bugzilla: //to be added//

Creating a MeeGo chroot

Area owners: Haito Feng

Priority: 2

Suggested location: developer.meego.com (DMC)

Status: Not started.

Open questions:

Should this feature be reassigned?

Link to MeeGo Wiki:

Creating a MeeGo chroot

Link to related feature in Bugzilla: //to be added//

UI guidelines

Handset UX guidelines

Area owners: Bob Spencer

Priority: 2

Suggested location: developer.meego.com (DMC), Guidelines

Status: Not started. Will be provided after 1.2

Link to MeeGo Wiki:

will probably be published in meego.com, in the following sections:
- UX design principles
- UI design guidelines

Link to related feature in Bugzilla: Feature 9487

Tablet guidelines

Area owners: Bob Spencer

Priority: 2

Suggested location: developer.meego.com (DMC), Guides

Status: Ready for publishing.

Link to documentation:

UI guidelines for tablet

Open issues:

Is this also needed Developer guidelines for tablet?

Link to related feature in Bugzilla: N/A

Reference material

Architectural overview

Area owners: Sunil Saxena

Priority: 1

Suggested location: meego.com, Architecture (?)

Status: Not started.

Open questions:

Should this feature be reassigned?

Link to MeeGo Wiki:

to be published in meego.com, see the following figures: MeeGo architecture overview, MeeGo architecture layer view,

MeeGo architecture domain view, and MeeGo architecture API view

Link to related feature in Bugzilla: Feature 9489

API reference (MeeGo API)

Area owners: Bob Spencer

Priority: 1

Suggested location: developer.meego.com (DMC), References

Status: At risk for 1.2; Ongoing, the overview pages are being updated in a separate wiki, from where the content is integrated to the API reference build.

Link to MeeGo Wiki: content available in a separate wiki.

Link to related feature in Bugzilla: Feature 9490

API reference (Platform API)

Area owners: Murali-Krishna Punaganti

Priority: 1

Suggested location: wiki.meego.com

Status: Ongoing.

Open questions:

What is the publishing location for the Platform API?

Link to MeeGo Wiki:

will probably be published in meego.com

Link to related feature in Bugzilla: Feature 9491

Links to relevant Qt documentation

Area owners: TBD

Priority: 3

Suggested location: various (depending on the page)

Status: Not started. At risk for 1.2

Link to MeeGo Wiki:

This feature covers various pages in the SDK developer documentation.

Link to related feature in Bugzilla: Feature 12463

Glossary for MeeGo 1.2 SDK

Area owners: Marianne Vaiciulis, Bob Spencer

Priority: 2

Suggested location: developer.meego.com (DMC), Glossary

Status: Ongoing, terms need to be added and definitions modified according to current SDK content.

Link to MeeGo Wiki:

Glossary

Link to related feature in Bugzilla: Feature 12241

Add libresourceqt API docs

Area owners: Bob Spencer

Priority:

Suggested location:

Status: Open

Link to related feature in Bugzilla: Feature 13215

API reference for Meego Input Methods for 1.2 (platform)

Area owners: Bob Spencer

Suggested location: developer.meego.com (DMC), Guides

Status:

Link to related feature in Bugzilla: Feature 14994

Documentation Bugs

Link to Documentation Bugs in Bugzilla: Documentation Bugs

Features postponed to a later release

Netbook UX guidelines

Area owners: Rob Bradford

Suggested location: developer.meego.com (DMC), Guides

Changes since MeeGo 1.1 SDK: New content area.

Status: Not started.

Open questions:

Question about this on meego-dev recently: http://article.gmane.org/gmane.comp.handhelds.meego.devel/9600 -- seen by Elliot Smith 09:34, 20 April 2011 (UTC)

Link to MeeGo Wiki: //to be added//

Link to related feature in Bugzilla: Feature 9488

Retrieved from "http://wiki.meego.com/Documentation_Backlog_for_MeeGo_1.2"

Category: Meego-1.2

@@ Line 19: / Line 19: @@
 '''Area owners:''' Marianne Vaiciulis, Taru Laine
-'''Changes since MeeGo 1.1 SDK''':
-Updates according to SDK implementation.
 '''Status''': Ongoing.
@@ Line 39: / Line 36: @@
 '''Suggested location''': developer.meego.com (DMC), References/Release notes
-'''Changes since MeeGo 1.1 SDK''': New content area.
+'''Status''': Done.
-'''Status''': In process.
 '''Link to MeeGo Wiki:'''
@@ Line 57: / Line 52: @@
 '''Suggested location''': developer.meego.com (DMC), SDK & Tools/SDK
-'''Changes since MeeGo 1.1 SDK''': New content area.
+'''Status''': Done
-'''Status''': Not started
 '''Link to MeeGo Wiki:'''
@@ Line 73: / Line 66: @@
 '''Suggested location''': developer.meego.com (DMC), Guides/Getting started
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Not started
@@ Line 93: / Line 84: @@
 '''Suggested location''': developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''': New content area.
 '''Status''': Not started
@@ Line 117: / Line 106: @@
 '''Suggested location''': developer.meego.com (DMC), Guides or SDK tools
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Ongoing.
@@ Line 124: / Line 111: @@
 '''Link to MeeGo Wiki:'''
 * [[SDK/Docs/1.2/Supported_operating_systems |Supported guest operating systems]]
-* [[SDK/Docs/1.2/Installing_and_configuring_MeeGo_SDK_for_Linux|Installing and configuring MeeGo SDK for Linux]]
+* [[SDK/Docs/1.2/Installing_and_configuring_MeeGo_SDK_for_Linux|Installing and configuring MeeGo SDK for Linux]] <span style="color:green;">DONE</span> -- [[User:Elliot|Elliot Smith]] 08:35, 20 May 2011 (UTC)
-* [[SDK/Docs/1.2/Checking_virtualization_support|Checking your system's graphics capabilities]]
+* [[SDK/Docs/1.2/MeeGo_SDK_Graphics_Acceleration|Checking your system's graphics capabilities]] <span style="color:green;">DONE</span> -- [[User:Elliot|Elliot Smith]] 08:36, 20 May 2011 (UTC)
 * NB Max has told me that this page [[SDK/Docs/1.2/Getting_started_with_the_MeeGo_SDK_for_Windows|Installing and configuring MeeGo SDK for Windows]] is obsolete; the proper instructions are at [[SDK/Docs/1.2/MeeGo_SDK_1.2_Preview_for_Windows]], but they are very sparse; I've asked Max what he plans to do with these two pages, and I'll review the result -- [[User:Elliot|Elliot Smith]] 11:15, 4 May 2011 (UTC)
-* [[SDK/Docs/1.2/Configuring_QEMU |Setting up the emulator]]
+* [[SDK/Docs/1.2/Using a MeeGo runtime with QEMU |Setting up the emulator]] <span style="color:green;">DONE</span> -- [[User:Elliot|Elliot Smith]] 10:08, 20 May 2011 (UTC)
 '''Link to related feature in Bugzilla:'''
@@ Line 143: / Line 130: @@
 '''Suggested location''': developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Not started
@@ Line 150: / Line 135: @@
 '''Link to MeeGo Wiki:'''
 * [[SDK/Docs/1.2/Setting_up_handset|Setting up your handset ]]
-* [[SDK/Docs/1.2/Setting_up_netbook|Setting up your netbook]]
+* [[SDK/Docs/1.2/Setting_up_netbook|Setting up your netbook]] <span style="color:green;">DONE</span> -- [[User:Elliot|Elliot Smith]] 10:22, 24 May 2011 (UTC)
 * [[SDK/Docs/1.2/Setting_up_tablet|Setting up your tablet]]
@@ Line 170: / Line 155: @@
 Content is being created in a separate wiki on the following topics:
-* Selecting the resource application class (will not be available for week 20)
+* Selecting the resource application class
 * Optimising power management
 * Performance management
@@ Line 191: / Line 176: @@
 '''Suggested location''': developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''':
-Updates according to SDK implementation.
 '''Status''': In process.
@@ Line 210: / Line 192: @@
 '''Suggested location''': developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''':
+'''Status''': <span style="color:green;">DONE</span> -- [[User:Elliot|Elliot Smith]] 12:35, 24 May 2011 (UTC)
-Updates according to SDK implementation.
-'''Status''': Not started.
 '''Link to MeeGo Wiki:'''
@@ Line 228: / Line 207: @@
 '''Suggested location''':
 wiki.meego.com
-'''Changes since MeeGo 1.1 SDK''':
-New content area.
 '''Status''': Not started.
@@ Line 246: / Line 222: @@
 '''Suggested location''': wiki.meego.com
-'''Changes since MeeGo 1.1 SDK''': New content area.
 '''Status''': Not started
@@ Line 267: / Line 241: @@
 '''Suggested location''':  developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Not started
@@ Line 289: / Line 261: @@
 '''Suggested location''':  developer.meego.com (DMC), Guides/FAQ or wiki.meego.com
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Ongoing. Content transferred from MeeGo 1.1 SDK developer library, needs to be updated for MeeGo 1.2 SDK.
@@ Line 307: / Line 277: @@
 '''Suggested location''':  developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''':
-New content area.
 '''Status''': Initial content with summary and links to currently open or planned vendor developer areas (where more instructions can be found). Also link to open-source repository apps.meego.com (work in progress).
@@ Line 325: / Line 292: @@
 '''Suggested location''': developer.meego.com (DMC)
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Not started.
@@ Line 342: / Line 307: @@
 '''Suggested location''': developer.meego.com (DMC)
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Not started.
@@ Line 365: / Line 328: @@
 '''Suggested location''': developer.meego.com (DMC), Guidelines
-'''Changes since MeeGo 1.1 SDK''':
-Updates according to SDK implementation.
 '''Status''': Not started.  Will be provided after 1.2
@@ Line 386: / Line 346: @@
 '''Suggested location''': developer.meego.com (DMC), Guides
-'''Changes since MeeGo 1.1 SDK''':
-New content area.
 '''Status''': Ready for publishing.
@@ Line 408: / Line 365: @@
 '''Suggested location''': meego.com, Architecture (?)
-'''Changes since MeeGo 1.1 SDK''':
-Updates according to SDK implementation.
 '''Status''': Not started.
@@ Line 431: / Line 385: @@
 '''Suggested location''': developer.meego.com (DMC), References
-'''Changes since MeeGo 1.1 SDK''':
-Updates according to SDK implementation.
 '''Status''': At risk for 1.2; Ongoing, the overview pages are being updated in a separate wiki, from where the content is integrated to the API reference build.
@@ Line 448: / Line 399: @@
 '''Suggested location''': wiki.meego.com
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Ongoing.
@@ Line 468: / Line 417: @@
 '''Suggested location''': various (depending on the page)
-'''Changes since MeeGo 1.1 SDK''':
-New content area.
 '''Status''': Not started. At risk for 1.2
@@ Line 486: / Line 432: @@
 '''Suggested location''': developer.meego.com (DMC), Glossary
-'''Changes since MeeGo 1.1 SDK''': Updates according to SDK implementation.
 '''Status''': Ongoing, terms need to be added and definitions modified according to current SDK content.
@@ Line 497: / Line 441: @@
 [http://bugs.meego.com/show_bug.cgi?id=12241 Feature 12241]
-==Sample Applications==
+=== Add libresourceqt API docs  ===
-'''Area owners:''' David Lawlor
+'''Area owners:'''  Bob Spencer
-'''Priority''': 2
+'''Priority''':
-'''Suggested location''': developer.meego.com (DMC), Guides/Samples
+'''Suggested location''':
-'''Changes since MeeGo 1.1 SDK''': New content area.
+'''Status''': Open
-'''Status''': Not started.
+'''Link to related feature in Bugzilla:'''
+[http://bugs.meego.com/show_bug.cgi?id=13215 Feature 13215]
-'''Link to MeeGo Wiki:'''
+===  API reference for Meego Input Methods for 1.2 (platform)===
-* [[SDK/Docs/1.2/Example_applications | Example applications]]
+'''Area owners:''' Bob Spencer
+'''Suggested location''': developer.meego.com (DMC), Guides
+'''Status''':
 '''Link to related feature in Bugzilla:'''
-[http://bugs.meego.com/show_bug.cgi?id=9492  Feature 9492]
+[http://bugs.meego.com/show_bug.cgi?id=14994 Feature 14994]
+=Documentation Bugs=
+'''Link to Documentation Bugs in Bugzilla:'''
+[https://bugs.meego.com/buglist.cgi?classification=MeeGo%20Platform&query_format=advanced&bug_status=NEW&bug_status=NEEDINFO&bug_status=ASSIGNED&bug_status=WAITING%20FOR%20UPSTREAM&bug_status=REOPENED&component=Documentation&product=MeeGo%20SDK Documentation Bugs]
 =Features postponed to a later release=

Views

Documentation Backlog for MeeGo 1.2

Latest revision as of 10:31, 12 April 2012

Contents

Contents of this page

Developer documentation

Getting started

Release notes for MeeGo 1.2 SDK

Download site for MeeGo 1.2 SDK

Getting started with MeeGo application development

Installation instructions (OBS)

Installation instructions (application SDK)

Device provisioning instructions

Developing with MeeGo SDK

Best practices documentation for MeeGo 1.2 SDK

Creating a Hello world application

Debugging instructions for MeeGo 1.2 SDK

Instructions for building MeeGo image/QEMU image

Packaging instructions (OBS)

Packaging instructions (Application SDK)

Troubleshooting information for MeeGo 1.2 SDK

Publishing instructions

Developing with Xephyr

Creating a MeeGo chroot

UI guidelines

Handset UX guidelines

Tablet guidelines

Reference material

Architectural overview

API reference (MeeGo API)

API reference (Platform API)

Links to relevant Qt documentation

Glossary for MeeGo 1.2 SDK

Add libresourceqt API docs

API reference for Meego Input Methods for 1.2 (platform)

Documentation Bugs

Features postponed to a later release

Netbook UX guidelines

Wiki Navigation

Search

Toolbox

Personal tools