Re: plone permissions manual

Mikko Ohtamaa wrote:

> Hi,
> 
> 
> This will not be a manual for developers or for programming
>> permissions. It's for understanding default permissions and what they
>> do. It will focus on what to expect when you change a permission for a
>> certain role. No ZCML, no generic setup profiles. No programmatic
>> manipulations of permissions. Just you and the check boxes in the ZMI.
>> I don't doubt that something more advanced is needed, but that is not
>> my goal here.
>>
> 
> My point was not about programming - I was hinting that the permission
> descriptions should be already available in the products.
> 
> Each permission should already have human readable description already, as
> stated here:
> 
> 
http://apidoc.zope.org/++apidoc++/ZCML/http_co__sl__sl_namespaces.zope.org_sl_zope/permission/index.html
> 
> If we want to maintain duplicate documentation of those descriptions it
> should be just a process of copy-paste those permission description texts
> to one documentation.

I'm ok with copy-pasting those descriptions where needed. Why not? I don't 
think they will change a lot over time, so copy-pasting should be enough.
 
> Or 1) if we want to relief the doc team from a task which does not belong
> for it 2) product authors have documented permissions with human readable
> descriptions in the first place, we can produce the manual JoAnne is
> looking for automatically.
> 
> Otherwise docteam will end up maintaining double permission descriptions
> and Zope users outside Plone community can't share the benefit of hard
> word of documenting the permissions.

I guess JoAnna is looking for something more elaborated than just a list of 
permissions and their descriptions, but also some examples and common use 
cases/customization. That's why I think that copy&pasting the descriptions 
is the best option for now. :)

-- 
israel



------------------------------------------------------------------------------
Come build with us! The BlackBerry® Developer Conference in SF, CA
is the only developer event you need to attend this year. Jumpstart your
developing skills, take BlackBerry mobile applications to market and stay 
ahead of the curve. Join us from November 9-12, 2009. Register now!
http://p.sf.net/sfu/devconf