Difference between revisions of "Documentation Team"

From Sugar Labs
Jump to: navigation, search
m (started cleaning up doc docs)
m (first iteration through docteam cleanup)
Line 6: Line 6:
 
We will be working with [http://flossmanuals.net/about FLOSS manuals] to create our end user documentation.  Their excellent getting started guide  is at [http://flossmanuals.net/OLPC_simple OLPC simple].  Works in progress are listed in the DocumentationTeam/KnowledgeBase .
 
We will be working with [http://flossmanuals.net/about FLOSS manuals] to create our end user documentation.  Their excellent getting started guide  is at [http://flossmanuals.net/OLPC_simple OLPC simple].  Works in progress are listed in the DocumentationTeam/KnowledgeBase .
  
See also [http://wiki.laptop.org/go/OLPC_Publications OLPC Publications] in the OLPC Wiki.
+
See also
 +
* [http://wiki.laptop.org/go/OLPC_Publications OLPC Publications] in the OLPC Wiki.
 +
* OLPC Austria's [http://www.olpcaustria.org/mediawiki/index.php/Activity_handbook Activity Handbook]
 +
 
 +
Topic Ideas
 +
* Setup a development environment.  With and without jhbuild.
 +
* "Write your activity" tutorial.  It should include:
 +
** graphic controls,
 +
** datastore,
 +
** collaboration.
  
 
== Programming References  ==
 
== Programming References  ==
 +
=== [http://api.sugarlabs.org API] ===
  
* sugar-base and sugar-toolkit has API documentation in the code. What tool do we use to generate html? Where do we generate it and where we make it available? Do we need to build them to generate docs?
+
The  [[DocumentationTeam/API_Documentation | API guide ]] explains how to get started documenting api.
:* See http://wiki.laptop.org/go/API_reference#System_Services.2FHardware for PyDoc and epydoc references. Also, how do we want to reference http://wiki.laptop.org/go/API_reference? Is it out of date? Do we start from scratch, or just update that?  --[[User:Morgs|Morgs]] 14:57, 30 May 2008 (UTC)
+
 
 +
References
 +
* http://wiki.laptop.org/go/API_reference?
 
* Probably we should document the datastore dbus API. I'm not sure what's the best way to generate documentation for it. It's so small that a wiki page might be the simpler solution for now.
 
* Probably we should document the datastore dbus API. I'm not sure what's the best way to generate documentation for it. It's so small that a wiki page might be the simpler solution for now.
* Collaboration API. I have no idea, morgs we need your help here.
+
* Existing collaboration documentation is at [http://wiki.laptop.org/go/Category:Collaboration Collabration].
:* Existing collaboration documentation is at [http://wiki.laptop.org/go/Category:Collaboration] --[[User:Morgs|Morgs]] 19:59, 15 May 2008 (UTC)
+
 
::* Morgs, my impression after a 3 minutes look over the available documentation is that there is little written with activity authors in mind, and that it's dispersed in several pages and mixed with implementation docs. Is that impression correct? I would like to have a couple of things: 1 complete documentation of the API which interest activity authors (with good links to dbus documentation since it's used so heavily) 2 A complete tutorial as part of the "manual". One of the Tubes pages looks like a pretty good start in this respect. Does it make sense to you? Can we make it happen? -- [[User:Marcopg|Marcopg]]
+
:* Morgs, my impression after a 3 minutes look over the available documentation is that there is little written with activity authors in mind, and that it's dispersed in several pages and mixed with implementation docs. Is that impression correct? I would like to have a couple of things: 1 complete documentation of the API which interest activity authors (with good links to dbus documentation since it's used so heavily) 2 A complete tutorial as part of the "manual". One of the Tubes pages looks like a pretty good start in this respect. Does it make sense to you? Can we make it happen? -- [[User:Marcopg|Marcopg]]
:::* Yes we can! --[[User:Morgs|Morgs]] 13:50, 16 May 2008 (UTC)
+
::* Yes we can! --[[User:Morgs|Morgs]] 13:50, 16 May 2008 (UTC)
:::* Hey, I came up with an alternate "reference" implementation for collaboration when I wrote Colors!, I think it's a lot easier to understand and could be the basis for a good tutorial.  The only weird thing is, I wanted my activity class to receive DBus signals directly, so I subclassed ExportedGObject but initialized late - hacky, I know.  It would be nice if this were not needed!  [http://dev.laptop.org/git?p=activities/colors;a=blob;f=colors.py;h=c262f55e46519248418a07e3c4eed1ab4207fa09;hb=5822328cab1162b32452dfb915b33d98307b55d1#l579] [[User:Wade|Wade]] 18:49, 18 May 2008 (UTC)
+
::* Hey, I came up with an alternate "reference" implementation for collaboration when I wrote Colors!, I think it's a lot easier to understand and could be the basis for a good tutorial.  The only weird thing is, I wanted my activity class to receive DBus signals directly, so I subclassed ExportedGObject but initialized late - hacky, I know.  It would be nice if this were not needed!  [http://dev.laptop.org/git?p=activities/colors;a=blob;f=colors.py;h=c262f55e46519248418a07e3c4eed1ab4207fa09;hb=5822328cab1162b32452dfb915b33d98307b55d1#l579] [[User:Wade|Wade]] 18:49, 18 May 2008 (UTC)
 
* Low level API (non-python activities). We should just move bert document on this wiki.
 
* Low level API (non-python activities). We should just move bert document on this wiki.
 
:this is the page http://wiki.laptop.org/go/Low-level_Activity_API but it must be complemented with  
 
:this is the page http://wiki.laptop.org/go/Low-level_Activity_API but it must be complemented with  
Line 23: Line 35:
 
:* http://www.catmoran.com/olpc/#sugxterm
 
:* http://www.catmoran.com/olpc/#sugxterm
  
== Manual ==
+
== Tutorials ==
  
* Setup a development environment. This is wiki oriented so we should probably not even mention jhbuild (we should definitely not do so until we have a bunch of autobuild slaves running).
 
* "Write your activity" tutorial. It should include all the important bits: graphic controls, datastore, collaboration
 
** see OLPC Austria's [http://www.olpcaustria.org/mediawiki/index.php/Activity_handbook Activity Handbook] [[User:ChristophD|ChristophD]] 03:59, 30 May 2008 (UTC)
 
 
* Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
 
* Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
 
* Etoys based activity tutorial?
 
* Etoys based activity tutorial?
  
 
[[Category:DocumentationTeam]]
 
[[Category:DocumentationTeam]]

Revision as of 14:13, 28 June 2008

Team Home   ·   Join   ·   Contacts   ·   Resources   ·   FAQ   ·   Roadmap   ·   To Do   ·   Meetings

Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.

User Manuals

We will be working with FLOSS manuals to create our end user documentation. Their excellent getting started guide is at OLPC simple. Works in progress are listed in the DocumentationTeam/KnowledgeBase .

See also

Topic Ideas

  • Setup a development environment. With and without jhbuild.
  • "Write your activity" tutorial. It should include:
    • graphic controls,
    • datastore,
    • collaboration.

Programming References

API

The API guide explains how to get started documenting api.

References

  • http://wiki.laptop.org/go/API_reference?
  • Probably we should document the datastore dbus API. I'm not sure what's the best way to generate documentation for it. It's so small that a wiki page might be the simpler solution for now.
  • Existing collaboration documentation is at Collabration.
  • Morgs, my impression after a 3 minutes look over the available documentation is that there is little written with activity authors in mind, and that it's dispersed in several pages and mixed with implementation docs. Is that impression correct? I would like to have a couple of things: 1 complete documentation of the API which interest activity authors (with good links to dbus documentation since it's used so heavily) 2 A complete tutorial as part of the "manual". One of the Tubes pages looks like a pretty good start in this respect. Does it make sense to you? Can we make it happen? -- Marcopg
  • Yes we can! --Morgs 13:50, 16 May 2008 (UTC)
  • Hey, I came up with an alternate "reference" implementation for collaboration when I wrote Colors!, I think it's a lot easier to understand and could be the basis for a good tutorial. The only weird thing is, I wanted my activity class to receive DBus signals directly, so I subclassed ExportedGObject but initialized late - hacky, I know. It would be nice if this were not needed! [1] Wade 18:49, 18 May 2008 (UTC)
  • Low level API (non-python activities). We should just move bert document on this wiki.
this is the page http://wiki.laptop.org/go/Low-level_Activity_API but it must be complemented with

Tutorials

  • Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
  • Etoys based activity tutorial?