Meego Wiki
Views

SDK/Documentation/MeetingMinutes/20110112

From MeeGo wiki
Jump to: navigation, search

Contents

Attendees

Agenda

  • Documentation-related features listed in Bugzilla for MeeGo 1.2 SDK release.
  • Getting help from the MeeGo Community on documentation related issues: OBS instructions, sample applications -> how to get this started?
  • Architecture documentation status (publishing of docs?)
  • Assigining responsibilities on SDK content areas

Content areas (according to features in Bugzilla)

Question: are we talking about updates, or are these new docs people are requesting? Many of these areas are covered in the SDK docs for 1.1; API refs are on apidocs.meego.com; some docs are elsewhere in the wiki but could be brought into the MeeGo SDK 1.2 TOC. It may be worth discriminating three cases by adding more comments to the bugs: (1) new content; (2) updates to existing content; (3) migration of content to the Developer Guide. -- Elliot Smith 11:20, 12 January 2011 (UTC)

Below listing has been taken from MeeGo 1.2 developer documentation related features in Bugzilla:

  • 9479 Developer documentation: Appropriate documentation shall be provided to developers
    • Responsibility for this area:
  • 9480 Getting started with MeeGo application development: Introductory document for getting started with development.
    • Responsibility for this area:
  • 9481 Installation instructions (OBS): How to install an OBS server & client.
    • Responsibility for this area: OBS server is probably out of scope (but covered by OBS setup anyway); client docs exist already (incomplete) - Build Infrastructure -- Elliot Smith 11:14, 12 January 2011 (UTC)
  • 9482 Installation instructions (application SDK): How to install the application SDK.
    • Responsibility for this area:
  • 9483 Device provisioning instructions: How to take a device into use as a development target.
    • Responsibility for this area:
  • 9484 Packaging instructions (OBS): How to package an application in the OBS.
  • 9485 Packaging instructions (application SDK):How to package an application in the application SDK.
    • Responsibility for this area:
  • 9486 Publishing instructions: How to publish software.
    • Responsibility for this area:
  • 9487 Handset UX guidelines: User experience documentation for the handset vertical.
    • Responsibility for this area:
  • 9488 Netbook UX guidelines: User experience documentation for the netbook vertical.
    • Responsibility for this area: Elliot?
  • 9489 Architectural overview: Architectural overview of the MeeGo software platform.
    • Responsibility for this area:
  • 9490 API reference (MeeGo API): API reference documentation for the future-proof MeeGo API interfaces.
    • Responsibility for this area:
  • 9491 API reference (Platform API): API reference documentation for the potentially unstable platform interfaces.
    • Responsibility for this area:
  • 9492 Sample Applications: IDE shall provide a set of sample applications. Each sample shall be buildable using both the application SDK and an OBS instance, each sample shall be usable on the supported set of execution environments (with deficiencies explicitly listed, if some functionality is not available). Each sample shall be covered with a license that enables building both open source and commercial software based upon it.
    • Responsibility for this area: Ville?
  • 9493 Other documentations: Shall provide some documents like How to install and setup SDK, 'Hello World", Sample applications, FAQ, Debuging and performance tunning, How to build MeeGo image/QEMU image: To be divided into separate features to facilitate tracking?
    • Responsibility for this area: Taru and Elliot
  • 12241 Glossary: Create a glossary with relevant terms for MeeGo 1.2 SDK. Use the Glossary for MeeGo 1.1 (http://wiki.meego.com/SDK/Docs/1.1/Terminology) as the basis and update accordingly. //added by Taru on 11 January.//
    • Responsibility for this area: Taru

New features (to be added to Bugzilla during week 2)

  • Release notes
    • Responsibility for this area: Veli, Bob
  • Download site
    • Responsibility for this area: Veli, Bob
  • Troubleshooting
    • Responsibility for this area: Taru and Elliot
  • Glossary
    • Responsibility for this area: Taru
  • Using OBS server through Web interface (community) ): To be discussed with Tero Kojo what would be the best way to kick-start the cooperation with the community.
    • Responsibility for this area: Taru (with Tero Kojo)
  • Links to relevant Qt documentation.
    • Responsibility for this area: Taru
  • MeeGo development best practices (community)
    • Responsibility for this area: Taru and Ville
  • WRT instructions (is this needed?) - not really core, as WRT is a platform API and effectively deprecated for MeeGo -- Elliot Smith 11:26, 12 January 2011 (UTC)
    • Responsibility for this area: Elliot?
  • Qt Simulator instructions (is this needed?)
    • Responsibility for this area: Elliot?

Live BugzillaReports on SDK docs features

It is possible to show a live lookup of SDK docs issues in the wiki: view the page source to see the required code.

Features

IDStatusAssigneeSeverityVersionSummary (26 tasks) ⇒
9479*
9479 Setting for release planning.
ACCEPTEDmariannelvenhancement1.2[FEA] Developer documentation
9480*
9480 Having both of these guides seems redundant, so perhaps they can be merged into one, taking the important bits of both, like here at developer.meego.com: http://developer.meego.com/guides/getting-started/meego-application-development-process
?		ACCEPTEDmacronenhancement1.2[FEA] Getting started with MeeGo application development
9481*
9481

This should be scoped to installing osc (the command line client), probably adequately covered here: http://wiki.meego.com/Build_Infrastructure/Packagers_Developers/CLI_Part_1

We don't want to explain setting up an OBS server.

It is related to #9484.
ACCEPTEDelliotenhancement1.2[FEA] Installation instructions (OBS)
9482*
9482

The responsibilities for this feature are divided as follows: 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
?		ACCEPTEDbspencerenhancement1.2[FEA] Installation instructions (application SDK)
9483*
9483

Instruction for setting up the handset is now ready at:

http://wiki.meego.com/SDK/Docs/1.2/Setting_up_handset
?		ACCEPTEDbspencerenhancement1.2[FEA] Device provisioning instructions
9484*
9484

The OBS content is at: http://wiki.meego.com/Build_Infrastructure/Packagers_Developers

But part 3 of this links out to an openSUSE page on OBS (http://en.opensuse.org/openSUSE:OSC). This makes it inconsistent with parts 1-2 and 4; also, an openSUSE page is obviously not tailored to MeeGo.

I'd say this is still a gap, but I may not get round to filling it.
ACCEPTEDelliotenhancement1.2[FEA] Packaging instructions (OBS)
9485*
9485

We need at least basic guidelines and a pointer to the compliance recommendations.

Mats Wichmann (Intel SDK team) can help along with John Chen
ACCEPTEDmwichmannenhancement1.2[FEA] Packaging instructions (application SDK)
9486*
9486 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). Are the current instructions sufficient for MeeGo 1.2 SDK? Can be completed by MeeGo 1.2 SDK release.
ACCEPTEDbspencerenhancement1.2[FEA] Publishing instructions
9487*
9487 Needs to be reassigned in Bugzilla.
ACCEPTEDbspencerenhancement1.2[FEA] Handset UX guidelines
9488*
9488

(In reply to comment #3)

Not that I'm aware of. I also checked with Chris Liu (who heads the design team in London which worked on netbook) and he said they don't exist and aren't likely to any time soon.
ACCEPTEDrbradfordenhancement1.2[FEA] Netbook UX guidelines
9489*
9489 Assigning to an architect. Arjan and Sunil to define. Bob to help document as needed.
?		ACCEPTEDsunilsaxenaenhancement1.2[FEA] Architectural overview
9490*
9490 Assigned to Taru.
?		ACCEPTEDkrishmuenhancement1.2[FEA] API reference (MeeGo API)
9491*
9491 Assigned to Taru.
?		ACCEPTEDkrishmuenhancement1.2[FEA] API reference (Platform API)
12241*
12241 Ongoing, terms need to be added and definitions modified according to current SDK content. Can be completed by MeeGo 1.2 SDK release.
ACCEPTEDmariannelvenhancementunspecified[FEA] Glossary for MeeGo 1.2 SDK
12461*
12461 Create release notes that describe the contents of MeeGo 1.2 SDK. The release notes will be published on the http://meego.com web site.
?		ACCEPTEDvelienhancementunspecified[FEA] Release notes for MeeGo 1.2 SDK
12462*
12462 Good idea. We should have a community troubleshooting page.
ACCEPTEDbspencerenhancementunspecified[FEA] Troubleshooting information for MeeGo 1.2 SDK
12463*
12463 Not started. -> can this be moved to a later MeeGo SDK release?
ACCEPTEDtarulaineenhancementunspecified[FEA] Linking from MeeGo 1.2 SDK developer documentation to relevant Qt documentation
12464*
12464 Ongoing. Planned to be completed by MeeGo 1.2 SDK release.
ACCEPTEDtarulaineenhancementunspecified[FEA] Best practices documentation for MeeGo 1.2 SDK
12788*
12788 Create a page that provides developers with links to the SDK and other relevant installers.
?		ACCEPTEDbspencerenhancementunspecified[FEA] Download site for MeeGo 1.2 SDK
13215*
13215

Nokia has opened, packaged and integrated the Policy framework into the MeeGo images, and now apps like dialer, music and video must port/integrate with it. This will be done by linking with and calling into libresourceqt.

Source repo for the project is at: http://meego.gitorious.org/maemo-multimedia/libresourceqt

The MeeGo package that contains the docs can be installed with the following command:

  1. zypper in libresourceqt-devel
ACCEPTEDbspencerenhancementunspecified[FEA] Add libresourceqt API docs
14994*
14994

(In reply to comment #3) > (In reply to comment #2) > > > Dominig, does that have something to do with this request to put the API > > documentation online? > > What I wanted to say is that having the input method documentation made > independent of the touch framework would be the first step to get it reuse by > other MeeGo vertical which would not use the touch framework. > > -- Dominig That has already happened :) www.maliit.org

Announcement: http://lists.meego.com/pipermail/meego-dev/2011-June/483526.html
ACCEPTEDbspencerenhancementunspecified[FEA] API reference for Meego Input Methods for 1.2 (platform)
15307*
15307

Below link contains the instructions to convert normal images to the one that could be used by QEMU for 1.1 release:

http://wiki.meego.com/SDK/Docs/1.1/Building_QEMU_Tools

1.2 release will add the description for Tablet I guess.
?		ACCEPTEDkarimianenhancementunspecified[FEA] Instructions for building MeeGo image/QEMU image
15308*
15308 Create instructions for debugging Qt applications running on a remote MeeGo device, using Qt Creator.
?		ACCEPTEDelliotenhancementunspecified[FEA] Debugging instructions for MeeGo 1.2 SDK
15310*
15310 How do we handle this feature?
?		ACCEPTEDdlawlorenhancementunspecified[FEA] Creating a Hello world application

Bugs

no bugzilla tickets were found
Retrieved from "http://wiki.meego.com/SDK/Documentation/MeetingMinutes/20110112"
Personal tools