Re: Dev documentation feedback

On 28/09/2010, at 7:01 AM, Mikko Ohtamaa wrote:

>
> Hi all,
>
> Just got these notes from a friend who tried to learn Plone. I will  
> record
> them here for the future purposes.

I really relate to the list of items below being whats missing.

I did a talk a few months back where I tried to explain plone to  
python programmers in about 30min. It actually went really well. I  
just uploaded the slides. I've been meaning to turn them into an  
overview section of the developer manual.

http://www.slideshare.net/djay/plone-for-python-programmers
http://pyconau.blip.tv/file/3841055

I think the hello world approach worked well and I think explaining  
traversal and basic zope concepts right up front really important. I  
think explaining the levels of customisation was really important but  
I could have done it better.

One thing I would have added is actually basic ZODB concepts not  
because I think people use them often but because it gives more  
context (and because I've come across developers who avoid pure zodb  
programming for no apparent reason other than they don't seem to  
understand it).


>
>
> What I'd like to see covered is:
> * what is the relationship between Plone and Zope
> * to what extent can bare Zope be used in Plone
> * how does Plone handle an incoming request (is this called  
> acquisition?) -
> compare this: http://web2py.com/book/default/chapter/04#Dispatching  
> (and if
> it's just Zope, then a pointer to the Zope details).
> * what is registration, why and how.
> * interfaces (I actually have an idea about interfaces from java,  
> but the
> concept should be in a beginners tute)
> * what are main add ons that people use/recommend (eg z3c.form etc)  
> and what
> they're good for
> * what parts of plone are now bad practice and should be avoided.
> * tools like Clouseau and DocFinderTab.
>
> While I think details on ZopeSkel, paster etc are important, they  
> can have
> (and do have) stand alone tutorials. I'd rather have something that  
> explains
> how the pieces fit together conceptually.
>
> -----
> Mikko Ohtamaa
> mFabrik - Freedom Delivered.
>
> Web site - http://mfabrik.com
> Mobile site - http://mfabrik.mobi
> Blog - http://blog.mfabrik.com
> -- 
> View this message in context: http://plone.293351.n2.nabble.com/Dev-documentation-feedback-tp5576907p5576907.html
> Sent from the Documentation Team mailing list archive at Nabble.com.
>
> ------------------------------------------------------------------------------
> Start uncovering the many advantages of virtual appliances
> and start using them to simplify application deployment and
> accelerate your shift to cloud computing.
> http://p.sf.net/sfu/novell-sfdev2dev
> _______________________________________________
> Plone-docs mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/plone-docs


------------------------------------------------------------------------------
Start uncovering the many advantages of virtual appliances
and start using them to simplify application deployment and
accelerate your shift to cloud computing.
http://p.sf.net/sfu/novell-sfdev2dev