Views
Sprint setup
Good morning sprinters! In case I am late or you are early and very industrious, here's what you'll need to do to get ready:
1) Create a fresh Zope instance (run mkzopeinstance.py)
2) Install Plone 2.0.5 - http://plone.org/downloads
3) Install Archetypes 1.3.1 - http://sourceforge.net/project/showfiles.php?group_id=75272 (Plone ships with an older version of AT). Get Archetypes-1.3.1-final-Bundle.tar.gz
4) Install VerboseSecurity? - http://hathawaymix.org/Software/VerboseSecurity
If you run into any security problems, this will help a lot. Don't install it on a production site, though, because it will slow things down. Be sure to read http://plone.org/documentation/apis/developer/HowToDebugUnauthorized if you hit any security exceptions. Shane Hathaway is a serious Zope guru who recently left Zope Corp to work on some big geneology project for the Church of Mormon; the products on his site are all very useful.
5) Install DocFinderTab? - http://www.plonesolutions.com/products/docfindertab DocFinderTab? exposes lots of documentation that is embedded in source code via a tab in the ZMI. Looking at the Doc tab on a ZMI object will save you a lot of digging through source files to track down APIs?. PloneSolutions? is Alexander Limi's company, and he employs a number of very smart people. PloneSolutions?' products are all quite useful as well.
6) Check out DCWorkflowDump? from the Collective on SourceForge? - http://sourceforge.net/projects/collective If you are going to be doing any work with PloneHelpCenter's workflows, DCWorkflowDump? will be a huge help. It takes a workflow that you have configured via the ZMI and dumps it to a python script that can recreate the workflow elsewhere. Click the CVS link (top right) for instructions on checking things out of CVS. You can check DCWorkflowDump? out via anonymous CVS. There are instructions on SourceForge?, and Tom Bryan should be able to help if you get stuck.:
cvs -d:pserver:anonymous@cvs.df.net:/cvsroot/collective login
cvs -d:pserver:anonymous@cvs.df.net:/cvsroot/collective export DCWorkflowDump
7) Check out PloneHelpCenter from the Collective on SourceForge? - http://sourceforge.net/projects/collective Click the CVS link (top right) for instructions on checking things out of CVS. You'll need developer CVS access (anonymous checkouts are read-only and are also delayed by up to 24 hours), so you'll need to set up SSH to SourceForge?. There are instructions on SourceForge?, and Tom Bryan should be able to help if you get stuck.:
set CVS_RSH=ssh
set CVS_EXT=filepathToYourSSHclient
cvs -d:ext:yourSFuserid@cvs.sf.net:/cvsroot/collective co -r BootCampSprint-branch PloneHelpCenter
8) Install PloneHelpCenter (PHC) in your new Zope instance.
9) If you are using Windows, install cygwin so you can use grep and find. Otherwise you will lose your mind. http://cygwin.com
10) Fire up Zope and play around with PHC to get an idea of what it does.
11) You're going to be using IRC and the mailing lists a lot during the sprint. Be sure to brush up on your #plone etiquette by reading http://plone.org/documentation/chat and http://plone.org/documentation/howto/ask-for-help
12) Sign on to the #plone IRC channel. It's usually pretty quiet on weekends, but there should be a few people around for the sprint. We might set up a separate channel for the sprint. Say hello! People are generally very friendly, especially if you follow the guidelines in (9)
13) Point your favorite usenet client to gmane.comp.web.zope.plone.user (archives of the plone-users mailing list) and gmane.comp.web.zope.plone.documentation (archives of the plone documentation list). There have been PHC discussions on the documentation list. The plone-users list is useful for general questions.
14) Poke through the PHC source to get a sense of what all is there. Files to look at: README.txt - always read README.txt! doc/Workflow.txt - this gives an overview of the workflow(s) used in PHC * Everything in the types/ directory. These are the Archetypes content objects. The skins/plone_help_center directory. It looks like a number of the bugs are in the various page templates. Extensions/Install.txt - This is the file that sets up PHC. It looks like a lot of the fixes needed will involve this file. DocFinderTab? will be your friend. * Ignore the other Extensions files -- they are irrelevant (the migration code) or automatically generated (the workflow files)
15) Read through the bug list on the Wiki.
16) Pick a bug that sounds interesting. Be sure to indicate on the Wiki that you're working on it so we don't end up with multiple people working on the same bug.
17) Get busy!
Geoff



