cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From da...@cocoon.zones.apache.org
Subject [DAISY] Updated: Cocoon Site Overview
Date Thu, 02 Nov 2006 21:19:44 GMT
A document has been updated:

http://cocoon.zones.apache.org/daisy/documentation/1201.html

Document ID: 1201
Branch: main
Language: default
Name: Cocoon Site Overview (unchanged)
Document Type: Cocoon Document (unchanged)
Updated on: 11/2/06 9:19:28 PM
Updated by: Reinhard Pötz

A new version has been created, state: publish

Parts
=====

Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 5218 bytes (previous version: 165 bytes)
Content diff:
    <html>
    <body>
    
--- <p>Welcome to the Cocoon documentation. This site uses a main navigation
--- document that integrates all different available pieces.</p>
+++ <h1>Documentation of the Cocoon documentation system</h1>
    
+++ <p>Welcome to the Cocoon documentation. This site integrates all available
+++ pieces of the Cocoon documentation. This document contains some short
+++ explanations of frequent documentation related tasks and an overview of the
+++ documentation architecture.</p>
+++ 
+++ <h1>How to ...</h1>
+++ 
+++ <h2>add a document?</h2>
+++ 
+++ <p>If you want to add a new document, go to the site at
+++ http://cocoon.zones.apache.org/daisy/ where you want to add the document to, and
+++ select "New Document". Choose "Cocoon Document" as type and start editing.
+++ Finally you have to add the document to the navigation document so that it
+++ appear in the menu structure.</p>
+++ 
+++ <h2>add a news item?</h2>
+++ 
+++ <p>Basically it is the same as "Adding a document", except that you choose "News
+++ Item" as document type. At the website the 7 latest news items are shown. Since
+++ the news items are selected by a query, they don't need to be added to a
+++ navigation document.</p>
+++ 
+++ <h2>add the documentation of a deployment unit=</h2>
+++ 
+++ <p>This guide explains in detail how the documentation of a new deployment unit
+++ (e.g. you want to add documentation for another block) can be added.</p>
+++ 
+++ <h1>Publishing</h1>
+++ 
+++ <h2>Publishing documents to http://cocoon.apache.org</h2>
+++ 
+++ <p>You have successfully created a new document, e.g. a new news item? And now
+++ you want to publish it to cocoon.apache.org? This task has to be performed from
+++ the shell at cocoon.zones.apache.org. Login via SSH (if you don't have a user,
+++ contact private@cocoon.apache.org) and switch to the "maven" user by "sudo su -
+++ maven" as it already is configured correctly to access the Daisy repository and
+++ it has all environment variables set correctly. Then go to
+++ /home/maven/site-generation and call the script "./update.sh" from there. This
+++ will recreate the documentation and deploy it to
+++ /home/maven/site-generation/site which is a SVN working copy of
+++ https://svn.apache.org/repos/asf/cocoon/site. Then do use svn stat to see what
+++ has changed and commit the changes. That's all. Within the next 4 hours, the
+++ changed site will be deployed to http://cocoon.apache.org.</p>
+++ 
+++ <p>In short all the required steps to re-publish the Cocoon documentation are:
+++ </p>
+++ 
+++ <pre>ssh cocoon.zones.apche.org
+++ sudo su - maven
+++ cd site-generation
+++ ./update.sh
+++ cd site
+++ svn stat
+++ svn add [files]
+++ svn commit --username [username] --pasword [password]</pre>
+++ 
+++ <p class="note">We haven't been using the new documentation system for
+++ publishing to cocoon.apache.org yet. That's the reason why the scripts are not
+++ available.</p>
+++ 
+++ <h2>Automatic publishing - Staging zone</h2>
+++ 
+++ <p>At http://cocoon.zones.apache.org/dev-docs/ you can find the staging zone of
+++ our documentation. It is recreated every 4 hours. If you don't want to wait for
+++ some reason, go to the Continuum web interface, and build the "$cdocs" project
+++ there, which will build and deploy the documentation. You have to log in as user
+++ "admin". The password can be found at
+++ /home/maven/password.txt@cocoon.zones.apche.org.</p>
+++ 
+++ <h1>How does the documentation system work?</h1>
+++ 
+++ <h2>The Daisy part</h2>
+++ 
+++ <p>The main rule of our documentation system is that every deployment unit has
+++ its own documentation. As we use the Daisy CMS this is achieved by having</p>
+++ 
+++ <ul>
+++ <li> one collection</li>
+++ <li> one navigation document and</li>
+++ <li> one site</li>
+++ </ul>
+++ 
+++ <p>per deployment unit .</p>
+++ 
+++ <p>In order to get an overview of all the pieces that are available, we have a
+++ special site "cdocs" at http://cocoon.zones.apache.org/daisy/cdocs/. There you
+++ will find everything that is part of the Cocoon documentation in some way.
+++ Currently these are three parts:</p>
+++ 
+++ <ul>
+++ <li><strong>Cocoon Book</strong>: The Cocoon book includes all the
+++ documentations of our deployment units (e.g. Cocoon Core, Cocoon Forms etc.) and
+++ can be used to use the Daisy book feature of creating e.g. a PDF of the complete
+++ docs.</li>
+++ <li><strong>Website only</strong>: There you will find all the documents
that
+++ are only avaiable on our website because it doesn't make sense to include them
+++ into our Cocoon Book. Examples are the main site (http://cocoon.apache.org) or
+++ the intermediate sites (http://cocoon.apache.org/blocks/).</li>
+++ <li><strong>Administration</strong>: There you will find documents that
make the
+++ use of our documentation system easier. These are things like links to all
+++ navigation documents, information about how to create a static version of the
+++ docs or how to add new documentation for a deployment unit.</li>
+++ </ul>
+++ 
+++ <h2>The publishing part</h2>
+++ 
+++ <p>The document extraction is done based on the Maven site generation tools. The
+++ documents are extracted from the Daisy repository server by the Daisy Maven
+++ plugin (see
+++ http://svn.cocoondev.org/repos/daisy/contrib/daisy-client-apps/trunk/daisy-maven-plugin/).
+++ The most important configuration parameters of the Daisy Maven plugin is the
+++ navigation document that is taken as starting point of the extraction process.
+++ </p>
+++ 
+++ <p>The plugin creates in src/site the document structure as expected by the
+++ Maven Site plugin. By using the Cocoon Site Skin plugin
+++ (http://svn.apache.org/repos/asf/cocoon/trunk/site/cocoon-maven-site-skin/) the
+++ final documents are created.</p>
+++ 
    </body>
    </html>


Mime
View raw message