Editing Task:Improving maemo.org/Development

Warning: You are not logged in. Your IP address will be recorded in this page's edit history.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Learn more about Contributing to the wiki.

== Proposed structure for development portal ===

This is a proposal for an improved structure for http://maemo.org/development

There is some discussion on bugzilla at [https://bugs.maemo.org/show_bug.cgi?id=3178 bug #3178: Developer documentation portal needs revision]

Different developers coming to maemo.org need four different things - to get started with a Maemo development environment, to get tutorial-type documentation that will help them use it, to consult reference documentation for the platform's APIs, and to get help when they run into problems.

So all of the things in the "Development" section can be split along these lines:

# "Getting started" or "Developer downloads" will include:
#* Instructions on downloading the SDK
#* A guide to getting a Scratchbox environment up & running
#* Links to the various useful tools & Eclipse integration
# "Documentation" or "Knowledge base" or whatever we want to call it will include:
#* The platform guide, including "Getting started", "Porting an app", and a guide to the components of the platform
#* Tutorials
#* Code samples
#* Training material - the technology overview, getting started, application development and platform development
#* Links to relevant material in the wiki
#* Links to useful external resources & articles, and kudos for upstream projects
# "Reference" will include:
#* Man pages - indexed and searchable
#* API docs for the platform - searchable!
# "Get help" will include:
#* Reference to the developers mailing list (with an RSS feed of latest threads)
#* Reference to IRC
#* Relevant material from the wiki (with an RSS feed of latest new pages)
#* A link to Bugzilla, with posting guidelines (and an RSS feed of bugs)

The one thing I'm having some trouble with is figuring out where Source code will go (it is after all vital). I suspect that it goes better in a separate section, or in "Developer downloads".

Note that not all of these things will be on the front page - the idea is to provide people with easily identifiable areas where they can find what they're looking for - any content on the portal page should reinforce the meaning of the categories, rather than be exhaustive.

=== Other ideas from brainstorm ===

During the brainstorm, the following points were proposed as priorities:

# Place references / howtos / tutorials onto one page so that developer does not need to click through several menus.
# Move outdated documentation away, but move older documentation that has not been updated for 4.x up, with a note "not fully applicable for 4.x".
# Make it possible for logged-in developers to annotate any place in the documentation. Link to annotations from documentation.
# Switch to SB2. SB1 is difficult to install and stays insulated from the rest of developer's system, making development complicated.
# Provide an example of simple build environment *not* relying on AutoConf and its friends. A single includable makefile should suffice, when used with SB2.
# Clearly *say* in the SB readme that it is not possible to debug every application on the desktop, show how to test applications on the target device using SSH/SCP or some other means.
# Maybe provide a few simple stylesheets and JavaScript libs for creating quick iPhone-like web apps running in MicroB. This should be very light, very easy to use, and targeted to casual users.

Of these, the proposed structure addresses the first point. The second point will be a useful side-effect of this. In addition, I propose that we begin dating release- or time-sensitive information to aid with this filtering process, both for site editors and for visitors.

I do not believe that we should address the goals of allowing annotations to all developer pages, addressing Scratchbox issues, and providing sample stylesheets for MicroB within the scope of revising the developer page structure. I propose that bugs be opened for specific issues and that these be addressed separately at some future date.

''Related pages'':
* [[Objective:Co-production_of_official_%26_community_documentation]] + [https://bugs.maemo.org/show_bug.cgi?id=101 Use the wiki for developer documentation]

Please note that all contributions to maemo.org wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see maemo.org wiki:Copyrights for details). Do not submit copyrighted work without permission!

Summary:

Cancel | Editing help (opens in new window)

Retrieved from "http://wiki.maemo.org/Task:Improving_maemo.org/Development"

Personal tools

Navigation

Views

Editing Task:Improving maemo.org/Development

@@ Line 1: / Line 1: @@
-== Proposed structure for development portal ==
+== Proposed structure for development portal ===
-This is a proposal for an improved structure for http://maemo.org/development - see [[Talk:Task:Improving maemo.org/Development|the talk page]] for ongoing discussion related to this content.
+This is a proposal for an improved structure for http://maemo.org/development
 There is some discussion on bugzilla at [https://bugs.maemo.org/show_bug.cgi?id=3178 bug #3178: Developer documentation portal needs revision]
@@ Line 10: / Line 10: @@
 # "Getting started" or "Developer downloads" will include:
-#* [http://maemo.org/development/sdks/maemo-4-1-diablo-sdk/ Instructions on downloading the SDK]
+#* Instructions on downloading the SDK
-#* [http://maemo.org/maemo_release_documentation/maemo4.1.x/node4.html A guide to getting a Scratchbox environment up & running]
+#* A guide to getting a Scratchbox environment up & running
-#* Links to the [http://maemo.org/development/tools/ various useful tools] (and [[Documentation/devtools|more useful tools]]) & [http://maemo.org/development/documentation/ide_integration/ Eclipse integration]
+#* Links to the various useful tools & Eclipse integration
 # "Documentation" or "Knowledge base" or whatever we want to call it will include:
-#* [http://maemo.org/development/documentation/Quick%20Start%20Guide/ Quick Start Guide]
+#* The platform guide, including "Getting started", "Porting an app", and a guide to the components of the platform
-#* [http://maemo.org/maemo_release_documentation/maemo4.1.x/ The platform guide], including "[http://maemo.org/maemo_release_documentation/maemo4.1.x/node7.html Getting started]", "[http://maemo.org/maemo_release_documentation/maemo4.1.x/node13.html Porting an application]", and [http://maemo.org/maemo_release_documentation/maemo4.1.x/node6.html a guide to the components of the platform]
+#* Tutorials
-#* [https://garage.maemo.org/svn/maemoexamples/tags/maemo_4.1/ Code samples]
+#* Code samples
-#* [http://maemo.org/development/training/ Training material] - [http://maemo.org/development/training/maemo_technology_overview_content/ technology overview], [http://maemo.org/development/training/maemo_getting_started_content/ getting started], [http://maemo.org/development/training/maemo_application_development_content/ application development] and [http://maemo.org/development/training/maemo_platform_development_content/ platform development]
+#* Training material - the technology overview, getting started, application development and platform development
-#* Link to (and a description of) [http://garage.maemo.org/ the garage]
 #* Links to relevant material in the wiki
 #* Links to useful external resources & articles, and kudos for upstream projects
-#* A link to the relevant pages explaining how to promote an app in extras & maemo.org/downloads.
-#* A link to the [http://www.forum.nokia.com/main/platforms/maemo/ Maemo pages at Forum Nokia].
-#* Note also the [http://maemo4mobile.garage.maemo.org/ Maemo for Symbian & .Net developers] documentation.
-#* '''See [[Talk:Task:Improving maemo.org/Development | Talk page]]''' [http://maemo.org/maemo_release_documentation/maemo4.1.x/node16.html Quality considerations]
 # "Reference" will include:
-#* [http://maemo.org/development/documentation/man_pages/ Man pages] - indexed and searchable
+#* Man pages - indexed and searchable
-#* [http://maemo.org/development/documentation/apis/4-1/ API docs for the platform] - searchable!
+#* API docs for the platform - searchable!
 # "Get help" will include:
-#* Reference to the [https://maemo.org/mailman/listinfo/maemo-developers developers mailing list] (with an [http://maemo.org/community/maemo-developers/rss.xml RSS feed of latest threads])
+#* Reference to the developers mailing list (with an RSS feed of latest threads)
-#* Pointer to [http://maemo.org/community/irc/ IRC] (no need to link to the page - simply refer to the channel)
+#* Reference to IRC
-#* Relevant material from the wiki (with [http://wiki.maemo.org/index.php?title=Special:Recentchanges&feed=rss an RSS feed] of latest changes)
+#* Relevant material from the wiki (with an RSS feed of latest new pages)
-#* A link to [http://bugs.maemo.org Bugzilla], with [https://bugs.maemo.org/page.cgi?id=bug-writing.html reporting guidelines] (and an RSS feed of recently (created/fixed/modified?) bugs)
+#* A link to Bugzilla, with posting guidelines (and an RSS feed of bugs)
-The one thing I'm having some trouble with is figuring out where [http://maemo.org/development/sources/ Source code] will go (it is after all vital). I suspect that it goes better in a separate section, or in "Developer downloads".
+The one thing I'm having some trouble with is figuring out where Source code will go (it is after all vital). I suspect that it goes better in a separate section, or in "Developer downloads".
 Note that not all of these things will be on the front page - the idea is to provide people with easily identifiable areas where they can find what they're looking for - any content on the portal page should reinforce the meaning of the categories, rather than be exhaustive.
@@ Line 57: / Line 51: @@
 ''Related pages'':
 * [[Objective:Co-production_of_official_%26_community_documentation]] + [https://bugs.maemo.org/show_bug.cgi?id=101 Use the wiki for developer documentation]
-== Proposed wireframe ==
-'''Or: Why Dave is not a Designer'''
-Core ideas: Simple block structure with developer-oriented RSS feeds in the sidebar.
-[[Image:Development_wireframe.png]]
-== Design proposal ==
-'''Or: Why Andre and Glaubert do graphical design'''
-[[Image:DEVELOPMENT.png]]
-[[Category:Community]]
-[[Category:maemo.org]]