SDK/Documentation/MeetingMinutes/20110112

Attendees

Bob Spencer, Taru Laine, Titta Väyrynen, Veli Kaksonen.

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
• MeeGo SDK 1.1.2 status: comments on release notes needed, blog post to be created

-> Taru to send the blog post and release notes for review after the meeting.

• Day and time for the weekly meeting:

Taru's suggestion: Thursday at this same time?

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)

Note: There is a Documentation component for the MeeGo SDK product, which I'd suggest we use for any documentation bugs; some of the below are filed under Tools, which makes them difficult to find. -- Elliot Smith 11:33, 12 January 2011 (UTC)

Below listing has been taken from MeeGo 1.2 developer documentation related features in Bugzilla. At the meeting we decided that Taru can start assigning the features to the responsible persons.

Here is the initial suggestion for the divisions of content areas by Taru:

• 9479 Developer documentation: Appropriate documentation shall be provided to developers
  • Responsibility for this area: Taru
• 9480 Getting started with MeeGo application development: Introductory document for getting started with development.
  • Responsibility for this area: Ronan
• 9481 Installation instructions (OBS): How to install an OBS server & client.
  • Responsibility for this area: Community/Elliot

    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: Taru for Linux and Elliot for Windows
• 9483 Device provisioning instructions: How to take a device into use as a development target.
  • Responsibility for this area: Elliot for Netbook and Taru for handset
• 9484 Packaging instructions (OBS): How to package an application in the OBS.
  • Responsibility for this area: Community/Elliot

see Build Infrastructure -- Elliot Smith 11:20, 12 January 2011 (UTC)

• 9485 Packaging instructions (application SDK):How to package an application in the application SDK.
  • Responsibility for this area: Taru
• 9486 Publishing instructions: How to publish software.
  • Responsibility for this area: Taru/Elliot/Community
• 9487 Handset UX guidelines: User experience documentation for the handset vertical.
  • Responsibility for this area: Ronan
• 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: Taru
• 9490 API reference (MeeGo API): API reference documentation for the future-proof MeeGo API interfaces.
  • Responsibility for this area: Murali/Janne?
• 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.//Should this be divided into four features: Example applications from community, sample applications included in the IDE, and tutorials for both?//
  • Responsibility for this area: Ville/Community/?
• 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?

  //(should this be divided into several features)?//

  • 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
• 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?

Other issues

• API categories, proposal compiled by Sakari Poussa and Janne Sormunen.
• Owner for Platform API: To be discussed with Murali and then decided
• Additional doc team members? -> Bob to revisit if we notice more people are needed.

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 (some of the arguments may still need to be tweaked).

Features

 1 qemu='/usr/lib/madde/linux-i686/tools/qemu-meego/bin/qemu-meego'
 2 qemu_path_native='/usr/lib/madde/linux-i686/tools/qemu-meego/bin/qemu-meego'
 3 libpath='LD_LIBRARY_PATH=/usr/lib/madde/linux-i686/tools/qemu-meego/lib'
 4 qemu_args='-hda meego-handset-ia32-qemu-1.1.20110110.1026-sda.raw -name      MeeGo -m 1024 -boot c -enable-kvm -vga std -enable-gl -device virtio-gl-p    ci -soundhw ac97 -skin /opt/meego/qemu-gl/share/qemugl/meego/skin/handset/skin.xml -usbdevice tablet -net nic -net user,hostfwd=tcp:127.0.0.1:666   6-:22,hostfwd=tcp:127.0.0.1:13219-:13219,hostfwd=tcp:127.0.0.1:14168-:14168'
 5 ip='127.0.0.1'
 6 sshport='6666'
 7 redirport2='13219'
 8 redirport3='14168'

Bugs