Task:Content Cleanup

Latest revision as of 15:36, 1 October 2008

This article is continued discussion from the maemo.org brainstorm
Please see the 100 Days agenda for more.

This is an accepted task and it is currently in the maemo.org development backlog. Probably nothing is stopping you from starting on it, though.
Please see the talk page for discussion.

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.

1 Site organisation
2 Get focused
3 Build environment
4 Longer-term goals
5 Development

[edit] 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.

[edit] 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

[edit] 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.

[edit] 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.--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.--qgil 07:34, 2 June 2008 (UTC)

[edit] Development

See Task:Improving maemo.org/Development

Related pages:

Objective:Co-production_of_official_&_community_documentation + Use the wiki for developer documentation

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

Categories: Brainstorm | Tasks | Accepted

This page was last modified on 1 October 2008, at 15:36.
This page has been accessed 18,909 times.

@@ Line 4: / Line 4: @@
 Connected to [[Task:Improving maemo.org]]
-Dress up the most important content, dump what is not relevant, handle via wiki the rest.
+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.
-* Get what's still useful and mostly relevant completely up to speed for maemo 4.x.
+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.
+* Mark the outdated stuff clearly. Date content in general with the last time it was reviewed.
-:''Agreed. What about a new wiki page listing what is '''really''' essential and should be put upfront? One approach could be to have the essential bits well written and presented in static-ish CMS pages and stable PDFs and then move all the rest to this wiki ecosystem. As soon as new wiki content gets really good we could productize it and promote it.--[[User:qgil|qgil]] 07:34, 2 June 2008 (UTC)''
+* 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.
-::''Don't create new wiki pages. The more pages you create, the more difficult it becomes to find and navigate stuff. Delete unused wiki pages instead. For documentation, you only need to have 1 (one) wiki page with a list of all references, how-tos, and tutorials that apply to the current OS (4.x). If a document does not 100% apply but is still useful, mark it as "partly deprecated". Create the same kind of pages for older OSes and link to them from the top of 4.x page, but make links small because this stuff is outdated and less important. [[User:fms|fms]] 16:16, 2 June 2008 (UTC)''
-:::''I meant a new wiki page just for working purposes, like the other ones being created to work on the 100 days objectives". In this working-wiki-page we would propose and agree on the very essential pages and diocs that need to be promoted and stand alone, while all the rest would be moved wither to really secondary pages (i.e. "Disclaimers") or wiki pages easy to be edited and improved.--[[User:qgil|qgil]] 08:57, 4 June 2008 (UTC)
-=== Get organized ===
-* Put together an easy-to-navigate, sensible index for the documentation content.
-** Place references/howtos/tutorials onto one page so that developer does not need to click through several menus.
-* Improve the search (google?).
-:''The plan is to have all the official HowTos and docs under a well structured ''Maemo Reference Guide''. Deadline: Diablo release. This reference guide would sit between the Quickstart Guide and the Training Materials. There were some fixes in the search and should be working much better now.--[[User:qgil|qgil]] 07:34, 2 June 2008 (UTC)''
-::''The website search has already been improved, will add this wiki to the search too. --[[User:xfade|xfade]] 13:37, 2 June 2008 (UTC)''
 === 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.
-* Make it possible for logged-in developers to annotate any place in the documentation. Link to annotations from documentation.
+: 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)''
-=== Look towards the future ===
 * Define types of applications that will be useful on the Internet Tablet
-* 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
 * 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 ===
-''(((The following items still need cleanup)))''
-There is some discussion at [https://bugs.maemo.org/show_bug.cgi?id=3178 Developer documentation portal needs revision]
+See [[Task:Improving maemo.org/Development]]
-The following points were added during the brainstorm, nobody has gone through:
+''Related pages'':
-. 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.
-On a related note:
 * [[Objective:Co-production_of_official_%26_community_documentation]] + [https://bugs.maemo.org/show_bug.cgi?id=101 Use the wiki for developer documentation]
-== Growing the community through better information for newcomers ==
-* Currently, maemo.org structure is less than favourable for newcomers to get familiar on what maemo software and maemo.org is. If we want to grow the community we need to provide better introduction to the community and the software assets. Hence, the content of the Intro section should be refreshed and restructured.
-* To  create more clarity, I would suggest to remove the "Tips for tablet users" because the link to OS2008 web page is already on the home page. I would furthermore move the "Roadmap" page to the "development" section. The gallery page should be moved to "downloads" and someone should clean up the gallery to contain only relevant content. The presentation section is to some degree outdated and should also be cleaned up. The "White Paper" page should be really give a quick overview of what maemo software is. The "trademark" and "licenses" pages should be moved to "Terms of Use". And the "Links" should be moved to "Development".
-* After all these changes, our intro section should include "Who is the maemo community?, What is the maemo platform? The maemo software architecture, How does maemo.org work? Quick start guide to develop on maemo software, and presentations" --[[User:peterschneider|peterschneider]] 10:02, 30 May 2008 (UTC)

Personal tools

Navigation

Views