Update todo list and architecture with Genshi and Elixir
[wiki.git] / projects / clockworks.mdwn
index 4ac2854cf635d17b7fe349291598922a8661f1c4..f32acab64eb53b2b86466a0b3b971b2e565078b4 100644 (file)
@@ -2,7 +2,11 @@
 
 Hey guys, I heard there was this app called [Doodle](http://www.doodle.com/main.html). It's closed source. Let's make an open-source Doodle killer and call it Clockworks!
 
-We have a mailing list - if you're interested in helping design the app, or if you just want to hear more about what we're up to,  just blanche yourself onto **clockworks**.
+We have a mailing list - if you're interested in helping design the
+app, just [let one of the developers know](mailto:clockworks@mit.edu)
+and we'll add you to our mailing list, **clockworks**. Or if you just
+want to hear more about what we're up to, blanche yourself to the
+public list **clockworks-announce**.
 
 ## Development info
 
@@ -12,27 +16,42 @@ Our Git repository is located in AFS in the clockworks locker: /mit/clockworks/c
 
 Doodle clone. 100% duplication of Doodle functionality. Modifications to improve usability as necessary.
 
+### Pitfalls to avoid
+
 What do people not like about Doodle?
 
 * Too much clicking
+ * We can deal with this by collapsing the three-page wizard Doodle has into a single page. Be careful not to sacrifice too much simplicity for such a setup.
 * No obvious "I can, but would rather not"
+ * Alleviated also by the above; this might want to be the default poll setup.
 
 ### What to do?
 
-* Configure the default TurboGears scaffolding
+* [Configure](http://docs.turbogears.org/1.0/Configuration?action=show&redirect=1.0%2FGettingStarted%2FConfiguration) the default TurboGears scaffolding
 * Work through the [TurboGears tutorial](http://docs.turbogears.org/1.0/Wiki20/Page1) (the tutorial seems to focus on SQLObject, which is not necessarily the best thing. Maybe someone can find some better docs?)
 * Setup database configuration and installer (an auxiliary issue is the presence of an installer for people). Also, make sure SQLAlchemy is being used
 * Learn SQLAlchemy
-* Make sure the default scaffolding works on Scripts (this includes running TurboGears as CGI). Any work done here should be considered for a TurboGears auto-installer, the equivalent of tgsetup)
-* Write a .gitignore file for generated/not versionable items
+* <del>Make sure the default scaffolding works on Scripts (this includes running TurboGears as CGI). Any work done here should be considered for a TurboGears auto-installer, the equivalent of tgsetup) (**ezyang**)</del>
+* <del>Write a .gitignore file for generated/not versionable items</del>
 * Get friendly URLs working
-* Learn TurboGear's templating interface (ezyang would like XSLT, but I don't think anyone else will let him use that)
+* Learn Genshi (The new TurboGear default templating interface for 1.1+)
+* <del>Setup a zephyrbot that watches the repository</del>
+* Learn [Widgets](http://docs.turbogears.org/1.0/Widgets) (we'll be using them for all of the forms in this website)
+* Polish up and get SSL authentication working with TurboGears Identity (the two should be integrated together in a sane manner.)
 
 ### Architecture
 
-* Python and Turbogears
-* Git repository
-* Use 15 minute timeslices to simplify interface (?)
+* **Language**: Python
+* **Framework**: TurboGears
+* **SCM**: Git
+* **JavaScript**: Mochikit
+* **Database**: SQLite for development, ? for production
+* **ORM**: SQLAlchemy (possibly Elixir?)
+* **Templating**: Genshi
+
+Other ideas:
+
+* Use 15 minute timeslices to simplify interface
 
 ### Principles
 
@@ -48,34 +67,34 @@ To be transferred from the whiteboard
 
 List of "screens" in Doodle
 
-* Home page
-* Help pages (screencasts, interactive JavaScript, etc.)
-* Schedule event (should be one-page-able)
+* **/**: Home page
+* **/help**: Help pages (screencasts, interactive JavaScript, etc.)
+* **/new**: Schedule event (should be one-page-able)
   * General info (title, description, name, email)
   * Days (calendar, should be AJAX)
   * Times (timezone (JS fill-in), add more timeslots, copypaste first row)
   * Options (yes-no-ifneedbe, hidden poll, limit OKs)
   * Poll created (admin, participant links)
-* View poll (timezone, name, times, information, functions)
-  * Edit entry (completely wiki!)
+* **/events/*event-name***: View poll (timezone, name, times, information, functions)
+  * **/events/*event-name*/edit**: Edit entry (completely wiki!)
   * Delete entry
-  * Add a comment
-  * Calendar export (both ways)
+  * **/events/*event-name*/comment**: Add a comment
+  * **/events/*event-name*/export**: Calendar export (both ways)
   * File export (excel, pdf)
-  * Subscribe (atom, and then social feed services)
-  * Embed poll (iframe)
-* Admin poll (participation link)
-  * Edit poll (all original options)
-  * History
-  * Delete all participants/comments
-  * Delete poll
+  * **/events/*event-name*/feed**: Subscribe (atom, and then social feed services)
+  * **/events/*event-name*/embed**: Embed poll (iframe)
+* **/events/*event-name*/admin**: Admin poll (participation link)
+  * **/events/*event-name*/admin/edit**: Edit poll (all original options)
+  * **/events/*event-name*/admin/history**: History
+  * **/events/*event-name*/admin/reset**: Delete all participants/comments
+  * **/events/*event-name*/admin/delete**: Delete poll
 
 ## Phase 2
 
 Doodle killer. Extra features. Pump it up.
 
 * Integration
-  * Basic: integration with ICS calendars, GoogleCalenar, Exchange, and TechTime (for faculty)
+  * Basic: integration with ICS calendars, GoogleCalendar, Exchange, and TechTime (for faculty)
   * Advanced: integration with MIT's course schedules, Facebook
   * Would store persistent profiles of calendar data for users
 * Automatically prioritize and schedule events for you
@@ -87,4 +106,6 @@ Doodle killer. Extra features. Pump it up.
 * Paul Baranay
 * Edward Yang
 * Paul Weaver
+* Xavid Pretzer
+* Christian Ternus
 * <a href="mailto:clockworks@mit.edu">You?</a>