Difference between revisions of "Documentation Team"

From Sugar Labs
Jump to: navigation, search
m (update links)
m (Remove link to dead URL, no longer relevant.)
 
(80 intermediate revisions by 19 users not shown)
Line 1: Line 1:
== API documentation ==
+
{{Translations
 +
  | [[Documentation Team|english]] | [[Documentation Team/lang-es|español]] }}
 +
<noinclude>{{TeamHeader|Documentation Team|home=Documentation}}</noinclude>
 +
== Mission ==
 +
{{:Documentation Team/Mission}}
 +
== Sugar FLOSS manual ==
 +
FLOSS Manuals held a BookSprint during the last week of August 2008 in Austin, TX; together, we wrote separate but combinable (remixable) manuals for Sugar, individual Sugar Activities and the hardware it may run on, such as the XO.
  
* 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 manuals for a number of Sugar Activities are now published (including manuals for [http://en.flossmanuals.net/write_activity '''Write'''], [http://en.flossmanuals.net/terminal '''Terminal'''], [http://en.flossmanuals.net/chat '''Chat'''], [http://en.flossmanuals.net/browse '''Browse'''], [http://en.flossmanuals.net/record '''Record'''], and [http://en.flossmanuals.net/turtleart '''Turtle Art''']).
 +
People "remixed" these manuals to form the [[Activities/Help|Help activity]] for the XO laptop; a version of this is on the web at http://laptop.org/manual/
 +
 
 +
Please help us improve these manuals by going to http://en.flossmanuals.net/write where the editable versions reside. Note that we are including tutorials and notes to parents and teachers as part of the documentation effort. Helping expanding these sections would be greatly appreciated.
 +
 
 +
Those who participated include: Adam Hyde, Anne Gentle, David Farning, Mikus Grinbergs, Brian Jordan, Adam Holt, Janet Swisher, Morgan Collett, Yama Ploskonka, David Cramer, Emily Kaplan, Faisal Anwar, Christoph Derndorfer, Sandy Culver, Aaron Konstam, and the Sugar community.
 +
 
 +
===Translation===
 +
We are translating the Sugar FLOSS manual into
 +
Spanish ([http://translate.flossmanuals.net/bin/view/Sugar_es es]),
 +
French ([http://translate.flossmanuals.net/bin/view/Sugar_fr fr]),
 +
Dutch ([http://translate.flossmanuals.net/bin/view/Sugar_nl nl]),
 +
German ([http://translate.flossmanuals.net/bin/view/Sugar_de de]),
 +
and Portuguese ([http://translate.flossmanuals.net/bin/view/Sugar_pt pt]). Please help us.
 +
 
 +
'''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  ==
 +
=== [http://api.sugarlabs.org API] ===
 +
 
 +
The  [[Documentation Team/API_Documentation | 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.
 
* 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 Collaboration].
:* 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 (see [[Development Team/Low-level Activity API]]) but it must be complemented with  
 
:* http://wiki.laptop.org/go/Sugar_Factory
 
:* http://wiki.laptop.org/go/Sugar_Factory
 
:* 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
 
 
* 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 - we now have an Etoys Activity manual set up on FLOSS Manuals. Feel free to contribute here: [http://en.flossmanuals.net/bin/view/Etoys/WebHome|Etoys]
 +
* Ideally, each Activity will have a tutorial within a manual on FLOSS Manuals. Here's a rough outline for each Activity Manual:
 +
 
 +
Introduction
 +
 
 +
Getting Started
 +
 
 +
Tutorials
 +
 
 +
Reference
 +
 
 +
== Auto-generated documentation ==
 +
 
 +
Some of Sugar Labs projects have auto generated (from source code) documentation. Follow the [http://doc.sugarlabs.org/ doc.sugarlabs.org] link to browse currently present documentation.
 +
 
 +
== Glossary ==
 +
 
 +
[[Documentation Team/Glossary | Glossary]]
 +
 
 +
== Subpages ==
  
== Community ==
+
{{Special:PrefixIndex/{{PAGENAMEE}}/}}
  
* [[Roadmap]]
 
* [[ReleaseTeam|Release process]]
 
* [[BugSquad/ContentToEdit/Triage|Bug triage]]
 
* Publish your activity. Maybe we need bits of infrastructure to make this easier, something like [https://addons.mozilla.org/ firefox addons] - proposal at [[Activity portal]]. But even just a wiki page could be start if we maintain it well.
 
  
[[Category:Developer]]
+
[[Category:Documentation Team]]
 +
[[Category:General public]]
 +
[[Category:Team]]

Latest revision as of 17:13, 29 April 2020

english | español HowTo [ID# 103656] 

Documentation   ·   Join   ·   Contacts   ·   Resources   ·   FAQ   ·   Roadmap   ·   To Do   ·   Meetings

Mission

The mission of the Documentation team is to provide the Sugar community with high quality documentation, including learners' manuals, programming references, and tutorials.

Sugar FLOSS manual

FLOSS Manuals held a BookSprint during the last week of August 2008 in Austin, TX; together, we wrote separate but combinable (remixable) manuals for Sugar, individual Sugar Activities and the hardware it may run on, such as the XO.

The manuals for a number of Sugar Activities are now published (including manuals for Write, Terminal, Chat, Browse, Record, and Turtle Art). People "remixed" these manuals to form the Help activity for the XO laptop; a version of this is on the web at http://laptop.org/manual/

Please help us improve these manuals by going to http://en.flossmanuals.net/write where the editable versions reside. Note that we are including tutorials and notes to parents and teachers as part of the documentation effort. Helping expanding these sections would be greatly appreciated.

Those who participated include: Adam Hyde, Anne Gentle, David Farning, Mikus Grinbergs, Brian Jordan, Adam Holt, Janet Swisher, Morgan Collett, Yama Ploskonka, David Cramer, Emily Kaplan, Faisal Anwar, Christoph Derndorfer, Sandy Culver, Aaron Konstam, and the Sugar community.

Translation

We are translating the Sugar FLOSS manual into Spanish (es), French (fr), Dutch (nl), German (de), and Portuguese (pt). Please help us.

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 Collaboration.
  • 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 (see Development Team/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 - we now have an Etoys Activity manual set up on FLOSS Manuals. Feel free to contribute here: [2]
  • Ideally, each Activity will have a tutorial within a manual on FLOSS Manuals. Here's a rough outline for each Activity Manual:

Introduction

Getting Started

Tutorials

Reference

Auto-generated documentation

Some of Sugar Labs projects have auto generated (from source code) documentation. Follow the doc.sugarlabs.org link to browse currently present documentation.

Glossary

Glossary

Subpages