Editing Task:Content Cleanup

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.

Connected to [[Task:Improving maemo.org]]

Break the site up according to various use-cases. For each part of the site, identify the most important content and put it up front.

Outdated official content should not appear in the primary navigation of the site, but should be accessible in an archive - esp. 3.x downloads, API documentation, guides.

The wiki can be one of two things - a sandbox for brainstorming or a repository for documentation. It's hard for it to be both.

=== Site organisation ===

* Use-case by use-case, figure out what the most important information on the site is, and make it easy to find.
** Concentrate on the site structure more than the content.
* If there is still useful and mostly relevant information which needs updating to the latest release, update. 
* Archive the outdated information away from the maemo 4.x stuff.
* Mark the outdated stuff clearly. Date content in general with the last time it was reviewed.
* Improve the search (google?). Make search by section possible (developer documentation, user & community sections) - ideally allow inclusion of Bugzilla, the wiki and itT in search results.

=== Get focused ===
* Add porting FAQ wiki page detailing common problems developers will run into (i.e. application is killed 3 seconds after launch) and how to deal with them. Provide examples of typical GTK/Motif/etc. application changes needed to properly Hildonize the application. List ways to deal with porting of toolkit-specific functionality whether it be internationalization or mouse/keyboard input.
: Sounds like the things in the FAQ need to be in the porting guide --15:36, 1 October 2008 (UTC)
* Stress the fact that the Internet Tablet is not a PC and apps should be created/ported with the tablet form in mind. Don't just do a direct port of an existing app. Aim for quality and Internet Tablet usability. 
* Focused discussion/guide on User Interface so apps will have a consistent look as well as provide a similar way to interface with the user

=== Build environment ===
* 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.

=== Longer-term goals ===

These will not be part of the initial website revision, because they require more substantial changes to infrastructure

* Make it possible for logged-in developers to annotate any place in the documentation. Link to annotations from documentation.
* Clearly define what changes is made by default on gtk : like GtkTreeView with hidden header columns by default, or image-button off ...
:''The idea is to have the sources of the official documentation here in this wiki. Users could add comments in the discussion pages, perhaps some users could get edit rights too. To be decided. The Nokia teams would updated their part of the documentation here and then all would be revised and conveniently package in PDF when a new stable release comes. So yes, we can put this in the 100 Days and then let's see how far we go in this timeframe.--[[User:qgil|qgil]] 07:34, 2 June 2008 (UTC)''
* Define types of applications that will be useful on the Internet Tablet
* 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.
:''Good ideas, they can be pushed by Nokia and the community. The point about Javascript libs is imho more of a 2010 Agenda thing, though. I don't mean we wouldn't have anything before 2010, but 100 Days is just too tight. Besides, the work to be done goes beyond maemo.org.--[[User:qgil|qgil]] 07:34, 2 June 2008 (UTC)''

=== Development ===

There is some discussion at [https://bugs.maemo.org/show_bug.cgi?id=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).

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.

''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)

Templates used on this page:

Template:100Days agenda (edit)
Template:Ambox (view source) (semi-protected)
Template:Task (view source) (semi-protected)

Retrieved from "http://wiki.maemo.org/Task:Content_Cleanup"

Personal tools

Navigation

Views

Editing Task:Content Cleanup

@@ Line 42: / Line 42: @@
 === Development ===
-See [[Task:Improving maemo.org/Development]]
+There is some discussion at [https://bugs.maemo.org/show_bug.cgi?id=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).
+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.
 ''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]