Workflow documentation added (first rough draft).

svn path=/plone.app.discussion/trunk/; revision=40206
This commit is contained in:
Timo Stollenwerk 2010-09-24 13:35:21 +00:00
parent 57758d2cf8
commit 4ec334b3d4
1 changed files with 64 additions and 0 deletions

64
docs/source/workflow.txt Normal file
View File

@ -0,0 +1,64 @@
=================
Comment Workflows
=================
This document describes the plone.app.discussion comment permissions and
workflows.
Introduction
============
Workflow and permissions...
Workflow
========
plone.app.discussion ships with a simple one-state workflow and a review
workflow for comments:
1) **Comment Single State Workflow**:
Essentially a workflow with no transitions, but it has a Published state,
so portlets and applications that expect that state will continue to work.
2) **Comment Review Workflow**: A simple review workflow for comments
...
.. note:: For a general introduction to workflows in Plone see:
http://plone.org/documentation/kb/creating-workflows-in-plone/
Comment Single State Workflow
-----------------------------
...
Comment Review Workflow
-----------------------
The comment review workflow comes with two states (pending and published) and
one transition (publish).
The 'pending' state is the initial state. 'published' is the state where the
comment is visible to everyone and non-editable.
The 'publish' transition is protected by the 'Review comments' permission.
::
* --> [pending] -- {publish} --> [published]--> *
Permissions
===========
"Review comments" permission, by default "Manager" and "Reviewer"
"Reply to item" permission, by default "Manager" and "Member"