You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@cocoon.apache.org by da...@cocoon.zones.apache.org on 2005/09/22 17:33:52 UTC
[DAISY] Updated: Apache Cocoon Documentation
A document has been updated:
http://cocoon.zones.apache.org/daisy/documentation/659.html
Document ID: 659
Branch: main
Language: default
Name: Apache Cocoon Documentation (previously Apache Cocoon)
Document Type: Document (unchanged)
Updated on: 9/22/05 3:33:34 PM
Updated by: Helma van der Linden
A new version has been created, state: publish
Parts
=====
Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name: (unchanged)
Size: 4017 bytes (previous version: 69 bytes)
Content diff:
<html>
<body>
--- <p>(to-be documentation homepage)</p>
+++ <p>This is the home page of the Apache Cocoon documentation in Daisy.</p>
+++ <p class="note">This page is <strong>NOT</strong> intended as the home page of
+++ the official Cocoon Documentation!</p>
+++
+++ <p>This site is intended as staging server for the official documentation at
+++ <a href="http://cocoon.apache.org/2.1/">http://cocoon.apache.org/2.1/</a>. The
+++ documentation is geared towards the current release (v2.1.7) and all future
+++ releases, although we try to keep the documentation as version-independent as
+++ possible.</p>
+++
+++ <h1>Writing documentation</h1>
+++
+++ <h2>New or occasional documentation contributors</h2>
+++
+++ <p>Although we invite everyone to contribute documentation, there are some rules
+++ to the game: if you are willing to write documentation, but you are not (yet?) a
+++ Cocoon committer, please register yourself at the Daisy site. You will get the
+++ role of "guest". You can then ask to be promoted to "editor" by sending a
+++ request to the <a href="mailto:dev@cocoon.apache.org">dev mailing list</a>. You
+++ can now add new documents, but it requires a Cocoon committer to actually
+++ publish the documentation. <br/>
+++ If you just want to contribute some documentation, but don't want to go through
+++ the process described above, please submit it to either the
+++ <a href="http://wiki.apache.org/cocoon/">wiki</a> or
+++ <a href="http://issues.apache.org/bugzilla/">Bugzilla</a>. Please add '[Docs]'
+++ as a prefix to your Bugzilla summary,</p>
+++
+++ <p class="note">Please verify if the information you want to add is not already
+++ present in some form or other, by either searching the Daisy site, the wiki or
+++ Bugzilla.</p>
+++
+++ <h2>Cocoon committers</h2>
+++
+++ <p>If you are going to write new information in the Daisy site, do verify if the
+++ documentation you are missing happens to be part of the
+++ <a href="http://cocoon.zones.apache.org/daisy/legacydocs/">Legacy
+++ Documentation</a> collection. If so, please update that document and move it to
+++ the "Cocoon Documentation" site (this site). You can do that through the
+++ collections tab in the edit page. Please remove the "legacydocs" collection
+++ entry after you've added the "documentation" collection.</p>
+++
+++ <h2>Legacy Documentation</h2>
+++
+++ <p>The legacy documentation was created on June 17 2005 in an attempt to
+++ consolidate the Cocoon documentation in this Daisy wiki site. It serves two
+++ purposes:</p>
+++
+++ <ol>
+++ <li>until the "Cocoon Documentation" site is revamped and completed (after lots
+++ of hard work, discussions and votes ;-)) the legacy docs site will serve as the
+++ source of the official Cocoon Documentation at
+++ <a href="http://cocoon.apache.org/2.1/">http://cocoon.apache.org/2.1/</a>.</li>
+++ <li>the legacydocs serve as a source for the "Cocoon Documentation" site in this
+++ Daisy wiki. All documents that are currently part of the legacy docs collection
+++ have to be evaluated and either updated or retired: when a document seems to be
+++ very outdated, please retire it (by selecting "retired" at the Options tab in
+++ the edit page). Otherwise, move it to the documentation collection and update it
+++ if necessary.</li>
+++ </ol>
+++
+++ <p>This means that the complete set of xdocs, currently present in the SVN
+++ repository will be checked for presence in the Daisy collection. If they are not
+++ present, they will be added to the legacydocs. Finally, the xdoc is removed from
+++ the SVN repository. Once all relevant xdocs are removed from the repository, no
+++ new documents should be added to the legacy docs.<br/>
+++ In the end, the legacydocs collection should contain only retired documents.</p>
+++
+++ <h1>Consolidating documentation</h1>
+++
+++ <p>Although there is a lot of information in these documentation pages, there is
+++ also a lot of valuable information in the wiki. If you, a Cocoon committer, find
+++ such gold nuggets in the wiki, please move the information over to this site and
+++ mark the wiki page with</p>
+++
+++ <pre>THE CONTENT OF THIS PAGE IS ADDED TO THE CORE DOCUMENTATION AND WILL BE DISPLAYED THERE IN THE NEXT UPDATE
+++ do not edit this page any more
+++ <yyyy/mm/dd> <your initials></pre>
+++
</body>
</html>
Fields
======
no changes
Links
=====
no changes
Custom Fields
=============
no changes
Collections
===========
Removed from collection: documentation