Start: Difference between revisions
m (add Category:Documentation) |
|||
(101 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
<div style="background: #5500BB; padding: 10px; border: 1px solid #CEA; border-bottom:none; font-size:180%; font-face:verdana,arial; color:#FFF;" align=center>Getting Started on the XO-1.5</div> |
|||
=== Book(let) Sprint: Updating the GETTING STARTED guide for OLPC's new XO-1.5!=== |
|||
<div style="background:red; padding:0px; font-size:120%;"><center> |
|||
{| cellpadding=6 cellspacing=0 |
|||
|- |
|||
|bgcolor="#white"| http://farm3.static.flickr.com/2762/4433782381_1ab8943398_m.jpg |
|||
|bgcolor="white"| |
|||
: '''March 27''' Saturday: Whiteboard TOC, Fact check, Rewrite, Dinner! |
|||
: '''March 28''' Sunday: Screenshots, Mouseover Finalization & Translation |
|||
|} |
|||
</center></div> |
|||
<div style="background: #5500BB; padding: 10px; border: 1px solid #CEA; border-bottom:none; font-size:180%; font-face:verdana,arial; color:#FFF;" align=center>'''Come and join our DC Community Book Sprint!'''</div> |
|||
<br> |
|||
We will overhaul & beautify these dozen HTML pages, including mouseovers:<br> |
|||
<i>Visit our LIVE-EDITABLE agenda: http://j.mp/laptopstartagenda</i> |
|||
=== Book(let) Sprint: Updating Walter Bender's Snazzy December 2007 "GETTING STARTED" guide...for OLPC's new [http://blog.laptop.org/2010/02/25/xo-1-5-early-production-laptops-free-to-contributors-worldwide/ XO-1.5] === |
|||
<i>Believe in Clean, Helpful documentation and open source tools??<br> |
|||
We invite you to join the OLPC/Sugar community, as we overhaul & beautify these dozen HTML pages critical to so many newcomers around the world -- including Spanish, French, Portuguese, Creole and interactive mouseovers -- all in one fast weekend sprint: |
|||
<h4>http://laptop.org/start</h4> |
<h4>http://laptop.org/start</h4> |
||
If the Amish community can raise a barn in 2 days, so can we! Like the Amish, we aim to KISS (keep it simple, stupid) by retaining the Clean/Helpful/Minimal look & feel that Walter Bender has created.</i> |
|||
== Time & Place == |
|||
Weekend of March 27/28, 2010<br> |
Weekend of March 27/28, 2010<br> |
||
9am to 7pm (both days) |
<i><b>9am to 7pm (both days!)</b></i> |
||
Arlington Career Center<br> |
Arlington Career Center: http://apsva.us/careercenter/<br> |
||
(1+ mile W. of the Pentagon)<br> |
|||
816 S. Walter Reed Dr<br> |
816 S. Walter Reed Dr<br> |
||
Arlington, Virginia<br> |
Arlington, Virginia<br> |
||
(1+ mile W. of the Pentagon) |
|||
http://apsva.us/careercenter/ |
|||
Google Map |
|||
http://j.mp/acc_va |
|||
Aerial photo map |
|||
http://www.flickr.com/photos/curiouslee/3515088488/ |
|||
Nearby: |
|||
* Clarendon Metro 1.5 miles from the ACC http://j.mp/clarendon_metro |
|||
* Walking from Clarendon Metro to the ACC http://j.mp/9NqBg5 |
|||
* 10B Bus from Ballston Station http://j.mp/10A-E [PDF] |
|||
* Days Inn two blocks away from the ACC http://j.mp/acc_daysinn |
|||
* Bangkok 54 http://www.bangkok54restaurant.com/ |
|||
* Lost Dog Cafe South http://www.lostdogcafe.com/about_south.htm |
|||
{{TOCright}} |
|||
== NEEDS! == |
== NEEDS! == |
||
* Inkscape/Gimp/Photoshop experts |
* Inkscape/Gimp/Photoshop experts |
||
* Javascript experts |
* Javascript experts |
||
* Certified Grannies |
|||
== Tools == |
|||
Beyond Walter's pioneering work, and FLOSSmanuals.net which we won't be using this time, we draw deep inspiration in the following <i>Clean, Helpful</i> documentation and (especially!) open source tools: |
|||
http://openoffice.org<br> |
|||
http://book.schooltool.org<br> |
|||
http://sphinx.pocoo.org<br> |
|||
http://kompozer.net<br> |
|||
http://atlassian.com/software/confluence<br> |
|||
http://www.httrack.com/ - Windows & Linux utility to download web sites<br> |
|||
https://addons.mozilla.org/en-US/firefox/addon/1616 - Spiderzilla - Firefox plug-in to download web sites<br> |
|||
https://addons.mozilla.org/en-US/firefox/addon/427 - Scrapbook - Firefox plug-in to download web sites<br> |
|||
Please [http://blog.laptop.org/2010/02/25/xo-1-5-early-production-laptops-free-to-contributors-worldwide/ apply for an XO-1.5] if you will be actively contributing, thanks! |
|||
== Site Audit == |
|||
* 16 profusely illustrated HTML pages |
|||
* 7 of the pages have interactive mouseover graphics |
|||
* 56 mouseover captions |
|||
* 20 Sugar activities described |
|||
* 51 screenshots |
|||
* Many external links |
|||
* Entire site available as one long PDF document |
|||
== Visual Site Map == |
|||
[http://www.flickr.com/photos/curiouslee/4461009145/sizes/l/ http://farm5.static.flickr.com/4016/4461009145_fe13758575.jpg] |
|||
Map image stored on Flickr |
|||
http://www.flickr.com/photos/curiouslee/4461009145/ |
|||
View 10625 x 6500px original map |
|||
http://www.flickr.com/photos/curiouslee/4461009145/sizes/o/ |
|||
== Project Tasks == |
|||
* Reuse as much of the existing HTML and Javascript as possible. Establish directory / file naming convention for the new pages. (Maybe http://www.laptop.org/xo-1.5/gettingstarted/ or http://www.laptop.org/10.2/gettingstarted/) |
|||
* Code keywords into all the new pages for search engine friendliness. |
|||
* Some of the text will need to be edited to reflect recent changes in the hardware and Sugar. |
|||
* Many new screenshots will need to be made. |
|||
* Some of the photo illustrations with callouts will need to be edited due to changes in Sugar or the laptop (e.g. expanded activity ring and new trackpad design). |
|||
* Re-use as many of the original photos and screenshots as possible. Continue to link to and store image assets in http://www.laptop.org/img/ |
|||
* Outbound links need to be rechecked. |
|||
* One or more new pages need to be written and illustrated to explain new features such as the control panel and Gnome Desktop. |
|||
* Preserve old set of start pages ( http://www.laptop.org/7.1.0/gettingstarted/ ) and clearly label that they are for the XO-1. Link to these from the new XO-1.5 start page. |
|||
* Add sidebar on new XO-1.5 pages to help people figure out which laptop/OS they have. |
|||
* Create some inbound links from elsewhere on www.laptop.org and other user group sites. |
|||
* Time permitting, all updated pages and illustrations to be collected into a downloadable PDF. |
|||
== Site Navigation == |
|||
* Preserve global navigation, sub-navigation and footer |
|||
* How to handle jump between pages for XO-1, XO-1.5, XO-1.75 (future) |
|||
* How to navigate to alternate language versions |
|||
== Image File Notes == |
|||
The images are a mix of GIF, PNG and JPEG. They all appear to be stored in |
|||
http://www.laptop.org/img/ |
|||
Sizes of screen shots of activities embedded in the pages vary: 427x320, 426x320 |
|||
In some cases, we may want to locate the original hardware photo from the OLPC Flickr stream in order to composite in new Sugar screens |
|||
http://www.flickr.com/photos/olpc |
|||
<b>Agreed upon naming convention for sprint screenshots:</b> oldfilename-xo15.suffix |
|||
== PDF document download == |
|||
The entire Getting Started collection of web pages is downloadable as a 103-page, 13mb PDF. Link text in the PDF is not clickable. The PDF is posted on Google Docs for viewing: |
|||
http://docs.google.com/fileview?id=0BxZJ13aT6vDYODFkOGZjNWMtZjMwOS00NmJlLThlZTQtODdmYzllZjdiNTA1&hl=en |
|||
The 56 mouseover captions are all broken out in one long stack in the document. |
|||
If this PDF is recreated from the new Getting Started pages, the file size can be reduced by optimizing through Acrobat. Clickable links should be preserved. Page numbering should be added. |
|||
== Other Snappy Intros to XO/Sugar == |
|||
http://laptop.org/manual equivalent to http://wiki.laptop.org/go/Help_(activity)<br> |
|||
http://wiki.sugarlabs.org/go/Features/Introduction_Tutorial<br> |
|||
http://booki.flossmanuals.net/discovering-discovery/ |
|||
See also [[Manuals]], [[Documentation Projects]] and [[ClassActs/Resources]]. |
|||
== References == |
|||
* OLPC XO-1 Start Page http://laptop.org/start |
|||
* G1G1 10.2 Activities List http://wiki.laptop.org/go/Activities/G1G1/10.2 |
|||
* XO-1.5 C2 Laptop http://wiki.laptop.org/go/XO_1.5_C2 |
|||
* F11 for 1.5 http://wiki.laptop.org/go/F11_for_1.5 |
|||
* Class Acts Book Sprint Resources http://wiki.laptop.org/go/ClassActs/Resources |
|||
* Gnome http://www.gnome.org/ |
|||
* G1G1 Box Flyer http://www.flickr.com/photos/curiouslee/tags/minimanual/ |
|||
* OLPC Flickr stream http://flickr.com/photos/olpc |
|||
* OLPC stock images of XO laptop http://www.flickr.com/photos/olpc/collections/72157607717555153/ |
|||
* Sugar Labs Activities site http://activities.sugarlabs.org |
|||
* Video on Flickr: Vision for the Sugar User Interface http://www.flickr.com/photos/olpc/3027607025/ |
|||
* Sprint graphic http://www.flickr.com/photos/curiouslee/4433782381/ |
|||
== Screenshot Gallery == |
|||
[http://www.flickr.com/photos/curiouslee/sets/72157623648868664/ http://farm5.static.flickr.com/4065/4461034281_8c83dfaa63_o.jpg] |
|||
http://www.flickr.com/photos/curiouslee/sets/72157623648868664/ |
|||
<b>Note on capturing screenshots:</b> I realized that some of my early screenshot captures were of initial static screens. It is much better to show a particular activity in an active state with as much interesting content as possible. -- Mike |
|||
<b>Google Spreadsheet inventory of screenshots:</b> |
|||
https://spreadsheets.google.com/ccc?key=0AhZJ13aT6vDYdDRDMDgyVXpXSzRyUWx4Qks0M2NOT0E&hl=en |
|||
<b>Agreed upon naming convention for sprint screenshots:</b> oldfilename-xo15.suffix |
|||
<b>Gallery of replacement illustrations:</b> http://www.visuallee.com/olpc_start_sprint_graphics/ |
|||
== Community Authors Coordination == |
|||
<i>Join our <b>library@lists.laptop.org</b> mailing list:</i><br> |
|||
http://lists.laptop.org/listinfo/library |
|||
<i>Live Chat:</i><br> |
|||
http://forum.laptop.org/chat |
|||
(that's #olpc-help on irc.freenode.net) |
|||
<i>Phone:</i><br> |
|||
Live calls will bring tactile contact with (active!) remote participants |
|||
== Attendees == |
== Attendees == |
||
* Beth Santos |
|||
<i>Translation volunteers will polish their work after the English Master Document freezes 7PM EDT Sunday March 28:</i> |
|||
* Beth Santos & Roberta Pospissil (PORTUGUESE TRANSLATION) |
|||
* Becky Young? |
|||
* Lionel Laske (FRENCH TRANSLATION) |
|||
* Caryl Bigenho (SPANISH TRANSLATION) |
|||
* Luke Faraone |
* Luke Faraone |
||
* Jeff Elkner |
* Jeff Elkner |
||
Line 25: | Line 200: | ||
* Adam Holt |
* Adam Holt |
||
* Seth Woodworth |
* Seth Woodworth |
||
* Amy Lee (copy editing, proofreading remotely and some pre-sprint prep) |
|||
* Sameer Verma? |
|||
* George Hunt |
|||
* Christoph Derndorfer (remote) |
|||
* Jerry aka DancesWithCars, my Sprint feedback here[http://wiki.laptop.org/go/User:DancesWithCars/XO1.5SprintFeedback] |
|||
* please add your name AND favorite HTML page you want to edit (of the dozen within http://laptop.org/start) |
|||
* Chris Leonard? |
|||
* Sameer Verma |
|||
* Christoph Derndorfer (GERMAN TRANSLATION) |
|||
* Samy Boutayeb (FRENCH TRANSLATION) |
|||
* Andrew Pompa (proofreading, editing) |
|||
* <i>please add your name AND favorite HTML page from http://laptop.org/start that you want to edit+modernize!</i> |
|||
== Accommodations / Offers / Requests == |
|||
Contact Adam Holt (holt @ laptop.org) and Mike Lee (curiouslee @ gmail.com) to see if anything's possible! |
|||
== Parking Lot For Post-Sprint Issues / Tasks == |
|||
* Updating the /start section raises the issue of updating pages elsewhere on Laptop.org, including: |
|||
** Activities (Sugar 7.1) - http://laptop.org/en/laptop/software/activities.shtml |
|||
** Laptop highlights - http://laptop.org/en/laptop/hardware/index.shtml |
|||
** Laptop Specs (XO-1) - http://laptop.org/en/laptop/hardware/specs.shtml |
|||
[[Category:Documentation]] |
|||
== Accommodations == |
|||
Contact Adam Holt (holt @ laptop.org) to see if anything's possible! |
Latest revision as of 05:41, 15 August 2010
http://farm3.static.flickr.com/2762/4433782381_1ab8943398_m.jpg |
|
Visit our LIVE-EDITABLE agenda: http://j.mp/laptopstartagenda
Book(let) Sprint: Updating Walter Bender's Snazzy December 2007 "GETTING STARTED" guide...for OLPC's new XO-1.5
Believe in Clean, Helpful documentation and open source tools??
We invite you to join the OLPC/Sugar community, as we overhaul & beautify these dozen HTML pages critical to so many newcomers around the world -- including Spanish, French, Portuguese, Creole and interactive mouseovers -- all in one fast weekend sprint:
http://laptop.org/start
If the Amish community can raise a barn in 2 days, so can we! Like the Amish, we aim to KISS (keep it simple, stupid) by retaining the Clean/Helpful/Minimal look & feel that Walter Bender has created.
Time & Place
Weekend of March 27/28, 2010
9am to 7pm (both days!)
Arlington Career Center: http://apsva.us/careercenter/
816 S. Walter Reed Dr
Arlington, Virginia
(1+ mile W. of the Pentagon)
Google Map http://j.mp/acc_va
Aerial photo map http://www.flickr.com/photos/curiouslee/3515088488/
Nearby:
- Clarendon Metro 1.5 miles from the ACC http://j.mp/clarendon_metro
- Walking from Clarendon Metro to the ACC http://j.mp/9NqBg5
- 10B Bus from Ballston Station http://j.mp/10A-E [PDF]
- Days Inn two blocks away from the ACC http://j.mp/acc_daysinn
- Bangkok 54 http://www.bangkok54restaurant.com/
- Lost Dog Cafe South http://www.lostdogcafe.com/about_south.htm
NEEDS!
- Inkscape/Gimp/Photoshop experts
- Javascript experts
- Certified Grannies
Tools
Beyond Walter's pioneering work, and FLOSSmanuals.net which we won't be using this time, we draw deep inspiration in the following Clean, Helpful documentation and (especially!) open source tools:
http://openoffice.org
http://book.schooltool.org
http://sphinx.pocoo.org
http://kompozer.net
http://atlassian.com/software/confluence
http://www.httrack.com/ - Windows & Linux utility to download web sites
https://addons.mozilla.org/en-US/firefox/addon/1616 - Spiderzilla - Firefox plug-in to download web sites
https://addons.mozilla.org/en-US/firefox/addon/427 - Scrapbook - Firefox plug-in to download web sites
Please apply for an XO-1.5 if you will be actively contributing, thanks!
Site Audit
- 16 profusely illustrated HTML pages
- 7 of the pages have interactive mouseover graphics
- 56 mouseover captions
- 20 Sugar activities described
- 51 screenshots
- Many external links
- Entire site available as one long PDF document
Visual Site Map
http://farm5.static.flickr.com/4016/4461009145_fe13758575.jpg
Map image stored on Flickr http://www.flickr.com/photos/curiouslee/4461009145/
View 10625 x 6500px original map http://www.flickr.com/photos/curiouslee/4461009145/sizes/o/
Project Tasks
- Reuse as much of the existing HTML and Javascript as possible. Establish directory / file naming convention for the new pages. (Maybe http://www.laptop.org/xo-1.5/gettingstarted/ or http://www.laptop.org/10.2/gettingstarted/)
- Code keywords into all the new pages for search engine friendliness.
- Some of the text will need to be edited to reflect recent changes in the hardware and Sugar.
- Many new screenshots will need to be made.
- Some of the photo illustrations with callouts will need to be edited due to changes in Sugar or the laptop (e.g. expanded activity ring and new trackpad design).
- Re-use as many of the original photos and screenshots as possible. Continue to link to and store image assets in http://www.laptop.org/img/
- Outbound links need to be rechecked.
- One or more new pages need to be written and illustrated to explain new features such as the control panel and Gnome Desktop.
- Preserve old set of start pages ( http://www.laptop.org/7.1.0/gettingstarted/ ) and clearly label that they are for the XO-1. Link to these from the new XO-1.5 start page.
- Add sidebar on new XO-1.5 pages to help people figure out which laptop/OS they have.
- Create some inbound links from elsewhere on www.laptop.org and other user group sites.
- Time permitting, all updated pages and illustrations to be collected into a downloadable PDF.
- Preserve global navigation, sub-navigation and footer
- How to handle jump between pages for XO-1, XO-1.5, XO-1.75 (future)
- How to navigate to alternate language versions
Image File Notes
The images are a mix of GIF, PNG and JPEG. They all appear to be stored in
Sizes of screen shots of activities embedded in the pages vary: 427x320, 426x320
In some cases, we may want to locate the original hardware photo from the OLPC Flickr stream in order to composite in new Sugar screens
http://www.flickr.com/photos/olpc
Agreed upon naming convention for sprint screenshots: oldfilename-xo15.suffix
PDF document download
The entire Getting Started collection of web pages is downloadable as a 103-page, 13mb PDF. Link text in the PDF is not clickable. The PDF is posted on Google Docs for viewing:
The 56 mouseover captions are all broken out in one long stack in the document.
If this PDF is recreated from the new Getting Started pages, the file size can be reduced by optimizing through Acrobat. Clickable links should be preserved. Page numbering should be added.
Other Snappy Intros to XO/Sugar
http://laptop.org/manual equivalent to http://wiki.laptop.org/go/Help_(activity)
http://wiki.sugarlabs.org/go/Features/Introduction_Tutorial
http://booki.flossmanuals.net/discovering-discovery/
See also Manuals, Documentation Projects and ClassActs/Resources.
References
- OLPC XO-1 Start Page http://laptop.org/start
- G1G1 10.2 Activities List http://wiki.laptop.org/go/Activities/G1G1/10.2
- XO-1.5 C2 Laptop http://wiki.laptop.org/go/XO_1.5_C2
- F11 for 1.5 http://wiki.laptop.org/go/F11_for_1.5
- Class Acts Book Sprint Resources http://wiki.laptop.org/go/ClassActs/Resources
- Gnome http://www.gnome.org/
- G1G1 Box Flyer http://www.flickr.com/photos/curiouslee/tags/minimanual/
- OLPC Flickr stream http://flickr.com/photos/olpc
- OLPC stock images of XO laptop http://www.flickr.com/photos/olpc/collections/72157607717555153/
- Sugar Labs Activities site http://activities.sugarlabs.org
- Video on Flickr: Vision for the Sugar User Interface http://www.flickr.com/photos/olpc/3027607025/
- Sprint graphic http://www.flickr.com/photos/curiouslee/4433782381/
Screenshot Gallery
http://farm5.static.flickr.com/4065/4461034281_8c83dfaa63_o.jpg
http://www.flickr.com/photos/curiouslee/sets/72157623648868664/
Note on capturing screenshots: I realized that some of my early screenshot captures were of initial static screens. It is much better to show a particular activity in an active state with as much interesting content as possible. -- Mike
Google Spreadsheet inventory of screenshots: https://spreadsheets.google.com/ccc?key=0AhZJ13aT6vDYdDRDMDgyVXpXSzRyUWx4Qks0M2NOT0E&hl=en
Agreed upon naming convention for sprint screenshots: oldfilename-xo15.suffix
Gallery of replacement illustrations: http://www.visuallee.com/olpc_start_sprint_graphics/
Community Authors Coordination
Join our library@lists.laptop.org mailing list:
http://lists.laptop.org/listinfo/library
Live Chat:
http://forum.laptop.org/chat
(that's #olpc-help on irc.freenode.net)
Phone:
Live calls will bring tactile contact with (active!) remote participants
Attendees
Translation volunteers will polish their work after the English Master Document freezes 7PM EDT Sunday March 28:
- Beth Santos & Roberta Pospissil (PORTUGUESE TRANSLATION)
- Becky Young?
- Lionel Laske (FRENCH TRANSLATION)
- Caryl Bigenho (SPANISH TRANSLATION)
- Luke Faraone
- Jeff Elkner
- Mike Lee
- Kevin Cole
- Adam Holt
- Seth Woodworth
- Amy Lee (copy editing, proofreading remotely and some pre-sprint prep)
- George Hunt
- Jerry aka DancesWithCars, my Sprint feedback here[1]
- Chris Leonard?
- Sameer Verma
- Christoph Derndorfer (GERMAN TRANSLATION)
- Samy Boutayeb (FRENCH TRANSLATION)
- Andrew Pompa (proofreading, editing)
- please add your name AND favorite HTML page from http://laptop.org/start that you want to edit+modernize!
Accommodations / Offers / Requests
Contact Adam Holt (holt @ laptop.org) and Mike Lee (curiouslee @ gmail.com) to see if anything's possible!
Parking Lot For Post-Sprint Issues / Tasks
- Updating the /start section raises the issue of updating pages elsewhere on Laptop.org, including:
- Activities (Sugar 7.1) - http://laptop.org/en/laptop/software/activities.shtml
- Laptop highlights - http://laptop.org/en/laptop/hardware/index.shtml
- Laptop Specs (XO-1) - http://laptop.org/en/laptop/hardware/specs.shtml