SDK/Documentation/MeetingMinutes/20110120

Latest revision as of 12:08, 24 January 2011

These are the meeting minutes for the Documentation status meeting of week 3.

Attendees

Taru Laine, Elliot Smith, Titta Väyrynen, Murali Punaganti,

Agenda

Issues discussed at the meeting:

• Assigned responsibilities for documentation-related features listed in Bugzilla for MeeGo 1.2 SDK release.

-> Are these OK with the team members?

• Getting help from the MeeGo Community on documentation related issues: OBS instructions, sample applications -> how to get this started?
  • AP Ville: discuss ideas with Quim etc. Ideas: templates? blog posts/mailing lists? Help with code snippets, too?
  • guidelines for tutorial writers on wiki: http://wiki.meego.com/SDK/Tutorial_content
• Architecture documentation status (publishing of docs?)
• MeeGo SDK features for documentation -> should we list these under Tools or Documentation?
  • AP Taru to discuss with Veli.
• API categories, proposal compiled by Sakari Poussa and Janne Sormunen.
• Owner for Platform API? -> Murali/Janne
• Deciding on a date when the SDK packages are "frozen" before the SDK release. This should be before the SDK docs are to be completed; ideally at least a couple of weeks before. This needs to be discussed with Veli and Fathi and decide how to schedule the documentation related to the SDK.
• MeeGo 1.2 Feature workshop next week -> who should participate? Possibly held next Thursday.
• Release cycle for future MeeGo releases -> timetables and documentation impacts. -> This could be discussed in next week's workshop.

  AP Taru: send link to the agenda of the February workshop (parts of that would possibly be covered on 27.1.2011?)

• AP Taru: To discuss with Ronan where is the MeeGo 1.2 SDK documentation published. What is the timetable for developer.meego.com?
  • Content process bug http://bugs.meego.com/show_bug.cgi?id=6340
  • Content process discussion http://wiki.meego.com/Application_developer_site (see "Content Process" section)
• Management of documentation related bugs in Bugzilla? -> mostly handled by Elliot.
• Current developer documentation-related priorities: Best practices (community support), TOC with placeholder pages
  • AP Taru: create initial backlog page for following work with linking to Featurezilla

Content areas (according to features in Bugzilla)

Here is the initial suggestion for the divisions of content areas by Taru. The content has also been divided into three categories, i.e. new documentation, updated documentation, and features to be added.

• 9479 Developer documentation: Appropriate documentation shall be provided to developers
  • Responsibility for this area: Taru

New documentation

This section lists new content that needs to be created for MeeGo 1.2 SDK.

• 9486 Publishing instructions: How to publish software.
  • Responsibility for this area: Taru/Elliot/Community
• 9488 Netbook UX guidelines: User experience documentation for the netbook vertical.
  • Responsibility for this area: Elliot?
• 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/?
• 12461 Release notes: 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.
  • Responsibility for this area: Veli, Bob
• 12462 Troubleshooting: Provide useful tips and solutions to potential problems that application developers may face when using MeeGo 1.2 SDK.
  • Responsibility for this area: Taru and Elliot
• 12463 Links to relevant Qt documentation: Add links to relevant sections of Qt documentation (especially tutorials and similar material) in the MeeGo 1.2 developer documentation in MeeGo Wiki.
  • Responsibility for this area: Taru
• 12464 MeeGo development best practices (community): Provide developers with practical instructions for developing applications with MeeGo 1.2 SDK. There could be tips and advice e.g. on performance, power management, backup and restore, testing, packaging guidelines, and UI implementation.
  • Responsibility for this area: Taru and Ville
• Download site: Page which provides developers with links to SDK and other relevant installers.
  • Responsibility for this area: Veli, Bob

Updated documentation

This section lists content that can be based on existing content for MeeGo 1.1 SDK but needs to be updated for MeeGo 1.2 SDK.

• 9480 Getting started with MeeGo application development: Introductory document for getting started with development.
  • Responsibility for this area: Ronan
• 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
• 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)

• 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
• 9487 Handset UX guidelines: User experience documentation for the handset vertical.
  • Responsibility for this area: Ronan
• 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: ?
• 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

This section lists features that have not been added to Bugzilla yet.

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