Plone Symposium 2008 Doc Sprint 

Suggested topics

(taken from Laura Trippi's summit summary sent to the doc list) 

1. Start Here Newbie Page for doc area 

http://dev.plone.org/plone/ticket/7833

Laura, JoAnna, Joel...others?

2. Diagrams of Plone stack and API overview
http://dev.plone.org/plone/ticket/7834

Steve M?

3. Add support for and identify topic owners in doc area
http://dev.plone.org/plone/ticket/7835

Steve M?

4. Information Architecture for docs : Docs Info Architecture

and see: http://dev.plone.org/plone/ticket/7836

 Laura, JoAnna

 

5. Theme documents  - Anne, Donna, others?

anneb: I'll have a better idea of what to do by the end of the week, am currently working on Theme Reference Manual and may need to get this finished off over the sprint. Anyone who wants to see the manual, comment, add stuff or just basically tell me what they want to see or how they would like things organised in it - let me know. I'll be available IRC 2pm to 9pm or later (GMT = 10-5 EST and 7-2 PST I think).
 

A. From the beginners point of view, a guide to where your files live - both using buildout and using the other installers (Windows as well). This is confusing now that we have eggs as well as products. http://www.nabble.com/Re%3A-docs-for-theming---progress-so-far-p15704996s6744.html

B. A tutorial for using  paster specifically for a theme.

C. More examples of using expressions in conditions in css / jss registry - how to restrict by content type, by position in the site ....

D.  A beginners / non-programmers overview of a Python class (such as that used for a viewlet)

 

6. Buildout recipes.

http://www.nabble.com/Where-to-find-recipes--td15704778s6741.html

 

7. ZPT tutorial update

http://plone.org/documentation/tutorial/zpt

Needs macros and slots info

 Marco

 

8. unfinished stuff from this summer? http://www.openplans.org/projects/doc-and-e-commerce-sprint/project-home

- workflow doc- Shaun may have you work on this. 

 

9. something from the tracker? http://dev.plone.org/plone/report/8 

- Updating Archetypes Developer Manual with GS support details. Possibly also, how to register "CMF skins" with ZCML. Publish the example code on plone.org.products. 

Kamon  (working remotely)

10. Windows specific

A small thing, but here:

 http://plone.org/documentation/tutorial/third-party-products/installing

and possibly here:

 http://plone.org/documentation/tutorial/buildout/prerequisites

have lots of additional comments to actually make the Windows stuff work. It would be good if these could be incorporated into the tutorials to make things more straightforward.

Windows and Python - the things you need to know...
 

11. marking outdated docs

Joel Burton suggests that the "this is outdated" message on not up-to-date docs is a bit too scaring and might be replaced by something like "not tested on current release" (suggestion by Marco De Vitis), maybe adding something else to exhort collaboration, e.g. "please contact the author of this document if you have any info on the applicability of this document to untested releases".

12. more ideas? Edit the wiki and add them

 

Participants

• Guy Heckman is interested
• Darci Hanning is interested; may be on-site, may be remote
• Anne Bowtell is definitely interested - but remote (UK - GMT).  Will happily research and write on whatever's required or will get down and do some theme documentation.
  
• Graham Perrin (remote, GMT) interested, subject to workload and other commitments
• Steve M - remote
  
• Kamon Ayeva (remote, GMT) is interested in starting the tasks he was planning to work on at the coming Paris sprint 
• Marco De Vitis (remote, GMT+1) is interested, mostly for the ZPT tutorial or Start Here newbie page
  
• Laura Trippi - part-time, remote (PDT)
• Rob Porter will be there.
  
• Shaun Hills- remote on something
• Joel Burton for 14 and 15 on whatever
  
• Christian Johansen will be there
• Catherine Williams will attend
• Donna M. Snow (remote, pst) Reviewing Anne's theming manual and any other ones that need review for publication
  
• that other guy whose name I've forgotten
• Jeff P. (?)
• Wayne G.
• Rose Pruyne will be there.
  

 

Location

The Documentation sprint will be in the Smeal Business Building in these rooms…

• Room 120 on March 14
  
• Room 217 on March 15-16