Added by Wil Sinclair, last edited by Wil Sinclair on Mar 15, 2008  (view change)

Labels

 

The Motivation

We've received a lot of feedback about the first hour of the Zend Framework experience. We won't get in to specific characterizations here, but suffice it to say that this is one part of the ZF experience that provides many opportunities for improvement. While we still have some ground to cover before we get the out-of-the-box experience of RoR and the clones, we think we've got a lot to offer as a framework precisely because we haven't focused on our Time to Hello World (TTHW). So how do we get ZF newcomers over the initial learning curve to witness the beautiful panorama on top that is ZF development? We think a great QuickStart would have the largest bang for the buck (and parenthetically (note the parentheses) is doable in the 1.5 timeframe).

The MO (Modus Operandi for all the Latin speakers out there)

It would be absurd to set off in this endeavour without soliciting the help of our ZF community, which has proven time and time again that it can produce excellent tutorials and QuickStarts. With that in mind, we put together this little contest to find out which contributor can produce the most useful, most effective, most entertaining, most up-to-date, and quickest QuickStart out there. And, seeing as we're never bashful about borrowing a good idea or two, we plan to use any choice bits from any of the submissions to put together the final version of the QuickStart. Really, we would call this the 'QuickStart Collaboration' if it were as catchy as the 'QuickStart Contest'.

The Prizes

Let's just get this straight from the outset: this is not about the prizes. This is about getting to the best QuickStart possible and having a little fun along the way. That said, the entries from which we select content will receive the following tokens of Zend's appreciation:

  • Winning Entry: We will pick one entry that will serve as the first working draft of the final QuickStart. The author of this entry will receive: 1 Zend Studio for Eclipse license, 1 Zend Framework T-Shirt, and recognition as the primary author in the online version of the QuickStart.
  • Entries From Which We Select Content: We will choose ideas and/or content from other entries that will add value to the primary entry. The author of such an entry will receive: 1 Zend Framework T-Shirt and recognition as a contributing author in the online version of the QuickStart.

The Rules

. . .or maybe the criteria for judging would be more accurate. As we might have mentioned already, we're trying to get to the most best QuickStart possible, which will have to deliver on many dimensions:

1) The following content should be covered:

  • Setting Up the Project using the default Project Structure (as described in this proposal: http://framework.zend.com/wiki/x/6KM)
  • Creating Controller/Views
  • Using Layouts
  • Using Forms
  • Db component, specifically creating a class/instance of Db_Table
  • CLI (if it's ready)

If it isn't obvious enough already, your entry should be compatible with the 1.5 release and- with the exception of new features- compatible with earlier releases. All topics should be read-at-will as possible (ie, the author should go through creating a basic controller/view before jumping in to the forms section), so the reader can skip section that are uninteresting to him/her.

2) Any code should be effective, brief, strictly compliant with ZF coding standards, and be made available for download with the QuickStart

3) Clarity

4) Readability (is it compelling/entertaining?)

5) Brevity (Should take no longer than 20 minutes on average to get a basic app up, and no more than 1 hour to cover all topics. About 6-10 printed pages of text- minus the screenshots of course- should be about right.)

6) Anything else that makes for a great QuickStart

7) All entries must be completed and moved to 'Completed Entries' before 12AM (that's midnight) PST, Sunday 3/9. It's not a lot of time, so get busy!

Grammar and spelling are not criteria, and we will be more than happy to help any selected content with English corrections. All entries must be submitted in some permutation of English, however.

The QuickStart Contest QuickStart

1) Create a new entry entering your full name when prompted.

2) Fill out the content, and don't hesitate to post questions/solicit comments to the appropriate mailing list.

3) Reparent your entry to 'Completed Entries' before the deadline.

4) Watch the general mailing list and this page for the winner(s) to be selected before the final release of 1.5. We will work with the winner(s) to make sure any edits to the final version are acceptable. Community voting may or may not be enabled on this page before the winners are announced to help us select the best.

The Disclaimers

  • Zenders can submit entries, but they will not be eligible for any of the prizes besides the recognition. Besides, if you guys want any of this stuff, just figure out who to take to lunch.
  • All content of all entries will be copyright Zend Technologies, as with all ZF documentation hosted on the ZF site.
  • All participants must have signed and submitted a CLA.

Draft Entries

Completed Entries

The Winners!

Aldemar Bernal and Bradley Holt both submitted excellent entries, each with it's own strong points. We felt that they complemented each other so well that both Aldemar and Bradley deserve the top spot. So congrats to Aldemar and Bradley, who will both recieve Zend Studio licenses, Zend Framework T-Shirts, and will share recognition as co-authors of the [ARCHIVE:Official ZF QuickStart].

The Official QuickStart Draft

The Official ZF QuickStart will be edited on [this page] and formatted for its finally home at http://framework.zend.com/docs/quickstart. This URL will be enabled as soon as the QuickStart is available.