cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Cocoon Wiki] Update of "CocoonWebsiteUpdate" by DavidCrossley
Date Fri, 18 Nov 2005 06:03:40 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Cocoon Wiki" for change notification.

The following page has been changed by DavidCrossley:
http://wiki.apache.org/cocoon/CocoonWebsiteUpdate

------------------------------------------------------------------------------
  #pragma section-numbers off
  
- This info is for Cocoon committers who need to update Cocoon's site.
+ This info is for Cocoon committers who need to update Cocoon's website.
  
  ==  See also ==
  
@@ -10, +10 @@

   * CocoonReleaseHowTo
  
  = WHERE DOES THE WEBSITE CONTENT COME FROM? =
- The website content comes from the http://svn.apache.org/repos/asf/cocoon/site/ repository.
These are the generated documents. 
+ The website content is held in the https://svn.apache.org/repos/asf/cocoon/site repository.
  
+ All generated documents are held in the "site" sub-directory.
+ 
- The source for the top-level website is in the src subdirectory containing the content that
we write (in xdoc format), and the corresponding website pages (generated by Forrest) are
committed to the site subdirectory, to make it easy to update or restore the content on the
live web server. This means that any manual changes to html pages in the site subdirectory
are ''lost'' when the site is regenerated using Forrest.
+ The source for the top-level website is in the "src" sub-directory containing the content
that we write (in xdoc format), and the corresponding website pages (generated by Forrest)
are committed to the "site" sub-directory, to make it easy to update or restore the content
on the live web server. This means that any manual changes to html pages in the site subdirectory
are ''lost'' when the site is regenerated using Forrest.
  
  The source of http://cocoon.apache.org/ index page, for example, is found at http://svn.apache.org/repos/asf/cocoon/site/src/documentation/content/xdocs/index.xml
  
  = HOW ABOUT DAISY? =
- Since 2.1.8, the documentation (apart from the general website pages) is written using daisy
at http://cocoon.zones.apache.org/, and Daisy-generated pages are processed by Forrest (using
forrest trunk) to generate the static pages (still in experimental phase).
+ Since 2.1.8, the documentation (apart from the top-level website pages described above)
is written using Daisy at http://cocoon.zones.apache.org/, and Daisy-generated pages are processed
by Forrest (using forrest trunk) to generate the static pages (still in experimental phase).
  
  Get these two repositories:
   * svn co https://svn.apache.org/repos/asf/cocoon/whiteboard/daisy-to-docs cocoon-daisy-to-docs
   * svn co https://svn.apache.org/repos/asf/forrest/trunk forrest-trunk
  
- People are still working out the details of this process, we should document it here when
it's stabilized. For the meantime, see the old notes below for how to produce the /2.1/ documentation.
+ = HOW TO UPDATE THE APACHE COCOON WEBSITE =
  
- = HOW TO UPDATE AN APACHE COCOON WEBSITE =
+ See the overview above. Here are the details ...
  
- Here are the steps to do this:
+ ==  A) Checkout the cocoon-site SVN ==
  
- ==  A) Checkout Cocoon SVN ==
+  * svn co https://svn.apache.org/repos/asf/cocoon/site cocoon-site
  
- Checkout source for the branch that you wish to update:
-  * CVS module cocoon-1
-  * CVS module cocoon-2.0
-  * SVN url https://svn.apache.org/repos/asf/cocoon/branches/BRANCH_2_1_X/ into cocoon-2.1
-  * SVN url https://svn.apache.org/repos/asf/cocoon/trunk/ into cocoon-2.2
- 
- If you have checkout already, just update it.
- 
- ==  B) Checkout Cocoon Site SVN ==
- 
- Checkout SVN url https://svn.apache.org/repos/asf/cocoon/site/ into cocoon-site. If you
have checkout already, just update it. This repository holds the generated docs for both the
top-level website and for each set of version-specific docs. It also holds the source xdocs
and the Forrest config files for the top-level website.
+ If you have checkout already, just update it. This repository holds the generated docs for
both the top-level website and for each set of version-specific docs. It also holds the source
xdocs and the Forrest config files for the top-level website.
  
  '''NOTE:''' cocoon-site is more than 60 Mb. You can checkout only part of it, say, for Cocoon
2.1, cocoon-site/site/2.1 (35Mb)
  
  '''NOTE:''' The javadocs are not stored in the cocoon-site SVN. They can easily be regenerated.
Use scp to copy them to the website.
  
- ==  C) Generate site ==
+ ==  B) Generate top-level site ==
  
  For the top-level website, just do the command 'forrest' in the top-level cocoon-site directory.
- After generation is complete, the site will be ready at the build/tmp/context/site/ directory.
Use forrest-trunk.
+ After generation is complete, the site will be ready at the build/site/ directory. Use forrest-trunk.
  
  View the generated docs to be sure that everything is as you would expect.
  
+ Now copy the generated docs:
+  * cd cocoon-site
+  * cp -Rf build/site/* site
- Old: This next paragraph is old, but don't want to delete just yet ...
- For the current release branch, e.g. 2.1, this is done by issuing commands 'build docs'
followed by 'forrest' in the shell in cocoon-2.1 root directory.
- The 'build docs' prepares some additional documents ready for rendering by Forrest.
- After generation is complete, the site will be ready at the build/cocoon-2.1.X-dev/site/
directory.
- Warning: Some recent changes have broken this. See the decision to only generate the "changes.html"
(http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=113150739111786 and http://marc.theaimsgroup.com/?t=113152350500001)
  
+ == C) Generate the 2.1 docs ==
+ 
+  * cd cocoon-daisy-to-docs
+  * forrest
+  * cp -Rf build/site/2.1/* ../cocoon-site/site/2.1
  
  ===  Forrest notes ===
  
-  * Use Forrest-trunk for the top-level docs - https://svn.apache.org/repos/asf/forrest/trunk
+  * Use Forrest-trunk - https://svn.apache.org/repos/asf/forrest/trunk
-  * Old: Use Forrest-0.6 for the 2.1 docs (or update the configuration to use forrest-0.7).
   * Out of the box, Forrest will not render PNG images in PDFs (due to license restrictions
on Jimi). You need to download Jimi from [http://java.sun.com/products/jimi/ Sun]. Copy the
!JimiProClasses.zip file to $FORREST_HOME/lib/optional/jimi-1.0.jar
  
  We should soon have the [http://forrest.apache.org/ Forrestbot] facility running, which
should make all of this vastly simpler.
  
  ==  D) Upload site into SVN ==
  
- Ensure that your cocoon-site is up-to-date (svn update). Copy the generated files to the
relevant directory under cocoon-site/site/ and then do the usual SVN stuff: 'svn status' 'svn
add' 'svn diff' 'svn commit' to commit the results into cocoon-site.
+ Ensure that your cocoon-site is up-to-date (do 'svn update' again). Copy the generated files
to the relevant directory under cocoon-site/site/ and then do the usual SVN stuff: 'svn status'
'svn add' 'svn diff' 'svn commit'
  
  ==  E) Update site on the server ==
  
  Steps are:
-  *  ssh into www.apache.org (or cvs.apache.org - same machine)
+  *  ssh people.apache.org (or cvs.apache.org - same machine)
   *  Check your environment: make sure your umask is set to 0002 ('umask 0002' in ~/.profile,
or use the "umask" command)
-  *  cd /www/cocoon.apache.org/x.y/
+  *  cd /www/cocoon.apache.org/
   *  svn update
   *  Double-check that all files you left over there are g+w so others can work from where
you finished.
  

Mime
View raw message