Cheatsheet structure

 The cheatsheet contains 3 Lists. Each list has "solutions". Each solution has a "technology stack" (the subheading), a "problem set" ("For:"), and a "documentation set" ("How:").

The technology stack is a short hand description of the combination of technologies that make up the best practice for this solution. They solve the problems listed in the problem set. The problem statements are short names for what you might be trying to do with plone. Some maybe linked to a page with a fuller description of the problem statement.

The lists indicate the current state of these solutions. Over time new solutions will appear of the new/alternative practices section, then perhaps get moved to the "current best practices section", replacing older solutions that will get moved to the "obsolete practices" section.

Cheatsheet for learners

You are just starting out and want to know where to start

Start at the top of the list and work your way down. The list is roughly ordered in a need to know basis.

How do I do X in plone?

First use Ctrl-f and try finding the problem you are trying to find in the "For:" sections.

If that fails then use the openplans search to try finding your problem is one of the problem pages linked from the cheatsheet. Each problem page will hopefully use the kind of keywords you are using to describe the your problem.

Try scrolling down the list and see if any of the problem statements ring a bell.

Try a google search and see if you can find  a tutorial or blog post.

If all that fails, go to the plone-users list and ask there. If you get a good answer then please come back to the cheatsheet and add a new section. Even if your new found solution isn't the best solution, it will be reviewed by experts who will fix it up.

 Important: The current best practices section can only contain one solution to a problem at a time. If you feel there are two solutions that apply under different circumstances they edit the document to problem statements state those circumstances.

Cheatsheet for experts

I know plone dev and I want to help

Join the project. Add your items. A daily change email will be sent to the group. This will mean your content is reviewed.

Alternatively just join the project as a reviewer. When people make changes you can help ensure its a good change.

I disagree with a solution in "current best practice"

First add your solution to the new solutions section. Link it to tutorials and any existing problem statements. Then join the project and discuss your proposed new best practice on the discussion list. If most people agree that this is indeed the new best practice then edit the cheatsheet again and move your solution and move the old way to the obsolete section.

I found a great tutorial...

First review the other tutorials listed for that solution. Make sure yours is better. Then edit the cheatsheet and put yours at the front of teh tutorial list.

I'm sick of people asking the same questions in plone-users

Send them to this list preferably with a hint of which solution to look for. If the solution isn't there then join and add it and then send them here. That way you never have to say the same thing twice again :) 

(more here)