cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From stev...@outerthought.org
Subject [WIKI-UPDATE] Doco Sun Nov 30 01:00:09 2003
Date Sun, 30 Nov 2003 00:00:10 GMT
Page: http://wiki.cocoondev.org/Wiki.jsp?page=Doco , version: 2 on Sat Nov 29 23:55:16 2003
by Stefanomazzocchi

- !!Contents
- *Description
- *Features at a glance
- *Architecture at a glance
- *Mail Threads
- *"Details"
- 
- 
- 
- # minimal, efficient and secure workflow (should satisfy board@ security concerns)
?                                                                 ^ ^^^^^^

+ # minimal, efficient and secure workflow (should satisfy board@ legal concerns)
?                                                                 ^ ^^^

- # should allow the creation of static content (should satisfy infrastructure@ and mirror@
concerns)
+ # should allow the creation of static content (should satisfy infrastructure@ load concerns
and mirror@ concerns)
?                                                                               ++++++++++++++

+ # should aim to reduce the production of custom code to a minimum (all code should go back
to the projects that it depends on, if makes sense to do so)
+ # should come up with structured XML content well organized in a versioned repository (should
aim to make content long-lasting and easily repurposed)
+ # should aim at complete internationalization of the content
- # should not be a distributed product (should avoid sensations of forking from existing
projects)
- # should reuse more than reinvent
- # should come up with structured XML content well organized in a repository
- 
-              +----------------+       +-----------------------------------------------+
                   
?                      ---------                                                         --------------------

+                      +-------+            +------------------------------------------------+
? ++++++++                      +++++                                                    
  +

-              | www.apache.org |       |                                               |
-          --->|                | wget  |+---------------+  publish +------------------+|
-  Browser     | httpd | CVS    |------>|| Forrest | SVN |<---------| FS/SVN  |  Lenya
||<--> Browser
-          <---|                |       |+---------------+          +------------------+|(public
authoring)
-              |                |       |                                  ^ |     ^ |  |
?                           -----                                          ---     - ^

+                      |       |            |                                            
   |
? ++++++++                     +                                                     ^^^^^^

-              +----------------+       |                                  | v     | |  |
-                                       |                           +-----------+  | |  |
-                                       |                           |  James    |  | |  |
+                      |       |   .----.   | +---------+   +------------+   +-------------+
|
+          browser <-->| HTTPd |<--|-__-|<--|-| Forrest |<->|   Slide  
 |<->|    Lenya    | |<--> Browser
+         (public      |       |   |    |   | +---------+   +------------+   +-------------+
|    (public
+          reading)    |       |   | FS |   |                /    |              ^       ^
  |     authoring)
+                      |       |   '-__-'   |            props  content          |       |
  |
+                      |       |            |              /      |              v       |
  |
+                      |       |            |         .----.   .----.   +--------------+ |
  |
+                      |       |            |         |-__-|   |-__-|   |   James      | |
  |
+                      +-------+            |         |    |   |    |   |--------------| |
  |
+                                           |         |DBMS|   | FS |   | workflow     | |
  |
+                                           |         '-__-'   '-__-'   |      mailets | |
  |
-                                       |                           +-----------+  | v  |
?                                                                                ---

+                                           |                           +--------------+ v
  |
? ++++                                                                              +++  
  +

-                                       +-----------------------------------------------+
+                                           +------------------------------------------------+
? ++++                                                                                   
  +

-                                                                         ^          ^
+                                                                            ^           ^
? +++                                                                                   +

-                                                                         |          | committer
authoring
?                                                                                     --------------------

+                                                                            |           |
? +++                                                                                   +

-                                                                         |          | (approve/reject,
etc.)
?                                                                                     -----------------------

+                                                                            |           |
? +++                                                                                   +

-                                                                         v          v
+                                                                            v           v
? +++                                                                                   +

-                                                                     Mailclient   Browser
+                                                                        Mailclient    Browser
? +++                                                                                 +

+ 
+                                                                        committer auditing
+                                                                      (approve/reject, etc.)
+ !!Details
+ !Editing
+ #Every public page will have a "edit" link. 
+ #This link will forward to a page that will include a WYSIWYG XHTML editor built inside
the browser (Linotype, currently works both on IE5+, Moz1.3+, Firebird 0.6+, no software needs
to be installed). 
+ #The editor will have a login form at the bottom:
+ ##if you are a committer, the changes go straight into the repository 
+ ##if not the workflow is started (there will be a hard-to-guess text image that the user
has to type in in order to avoid spamming bots)
- !!Mail Threads
+ !Mail Workflow (thru James and custom mailets)
+ # If document is submitted by a non-committer, email is sent to the 'documentation committer'
list (which is a private list) for that particular project
+ # Committer will receive an email similar to moderate ezml moderate emails and diff between
published and authoring/working document are being shown. , e.g.
+ **project-subproject-accept-1067323167.74085.bhhdiekdcmdijjeaiknc@doco.apache.org
+ **project-subproject-reject-1067323167.74085.bhhdiekdcmdijjeaiknc@doco.apache.org
+ # if three "accept" and no "reject" emails are obtained, the diff is allowed into the repository
+ # if at least one "reject" is found, the mail workflow is stopped and workflow has to be
resurrected by connecting to the backend with a browser
+ !Web Workflow (thru Lenya)
+ # thru a web interface, a documentation committer for a particular project has the ability
to undo changes and resort to previous versions of the documents. 
- __Lenya Dev:__\\
- [http://news.gmane.org/onethread.php?group=gmane.comp.cms.lenya.devel&root=%3C3F97CC8A.3040102%40apache.org%3E]\\
- \\
- \\
- [http://news.gmane.org/onethread.php?group=gmane.comp.cms.lenya.devel&root=%3COFACF489EA.B74EF621-ON80256DC9.002C873F-80256DC9.002D77F5%40slc.co.uk%3E]
- \\
- \\
- __Cocoon Dev:__\\
- [http://news.gmane.org/onethread.php?group=gmane.text.xml.cocoon.devel&root=%3C3F97CC8A.3040102%40apache.org%3E]
- \\
- \\
- __Forrest Dev:__\\
- [http://news.gmane.org/onethread.php?group=gmane.text.xml.forrest.devel&root=%3C3F97CC8A.3040102%40apache.org%3E]\\
- [http://news.gmane.org/onethread.php?group=gmane.text.xml.forrest.devel&root=%3COFC1978CA9.BBD6B5F3-ON80256DCD.002E80FE-80256DCD.002EF321%40slc.co.uk%3E]\\
- \\
- __James Dev:__\\
- [http://news.gmane.org/onethread.php?group=gmane.text.xml.forrest.devel&root=%3CNBBBJGEAGJAKLIDBKJOPEEJGEOAB.noel%40devtech.com%3E]
+ !Content Repository 
+ # must have WebDAV interface (to allow language abstraction and installation on different
machines)
+ # must have DeltaV linear versioning or autoversioning (to allow rollback in case bogus
or vandalized content sneaks in)
+ # must have DASL capabilities with ability to run queries against live properties (which
will be used by the workflow system)
+ Slide is the only open source project that is able to support all these things. (Note: subversion
does 1# and 2# but not 3#!!)
+ !Publishing System
+ # must generate static documentation
+ # must be able to operate on a WebDAV repository thru a DASL layer
+ Cocoon gives DASL quering capabilities that Forrest can use to obtain the XML documents
from.
- !!"Details"
+ !!Issues
+ !Editing
+ # how do we edit navigation structures (sidebars)? 
+ 
+ !Staging to Live
+ # how do we transfert the content to the main web machine? croned inverted rsynch? direct
transparent proxying/caching?
- !Workflow
- # If document is being edited and saved, then email is sent to the 'doco committer' list
(which is a private list)
- # Committer will receive an email similar to moderate ezml moderate emails and diff between
published and authoring/working document are being shown. , e.g.
- **lenya-dev-accept-1067323167.74085.bhhdiekdcmdijjeaiknc@cocoon.apache.org
- **lenya-dev-reject-1067323167.74085.bhhdiekdcmdijjeaiknc@cocoon.apache.org.
- # If diff is accepted then the page will be published
- # If diff is rejected then ...?
+ # how can we make the channels more secure? SSL on the editing part and PGP/SMIME signing
the mail replies?
- # reply and reply-all ... what about showing them as a "mailto" link within the email?
- # sniffing and spoofing ... what about a 4eyes approach, i.e. at least two committers need
to approve, although doesn't really make it bulletproof ...
- # Content needs to be checked after being approved (images, code snippets, etc.) ... what
about checking content during saving already?
- 
- !Editing
- # The public-authoring interface will only have a "EDIT" button
- # By clicking on "EDIT" Linotype will be opened
- # New documents could be inserted via "Wiki style", but instead of using Wiki syntax one
could use <a href="NewDocument">...</a> where Lenya would need to parse the page
and highlight non-existing links
- # Lenya can provide a committer-authoring interface, where workflow (also history), revisions,
editing could be stuffed within the Lenya menubar.
- 
- !Staging to Live
- # every 12 hours www.apache.org is retrieving the data from the staging server. What if
the staging system is being cracked five minutes before the actual retrieval time? Maybe Lenya
could keep each document in a publish queue for at least 12 hours. Also every retrieval could
set a CVS flag, such that changes can be easily reverted.
- 



Mime
View raw message