db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "DerbySnapshotOrRelease" by DyreTjeldvoll
Date Thu, 01 May 2008 16:10:27 GMT
Dear Wiki user,

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

The following page has been changed by DyreTjeldvoll:
http://wiki.apache.org/db-derby/DerbySnapshotOrRelease

------------------------------------------------------------------------------
    using db-derby-10.1.1.0 as the release to link to -current as an example.
  
   1. Copy the latest version of the documentation to the doc directory on the website. 
-   The documentation is included in the release you uploaded, but unfortunately its directory
structure quite right for the website. To get around this you need to unzip the `db-derby-x.y.z.w-bin.zip`
archive, rename some directories and copy the pdf files into the html hierarchy. Here is a
shell script outlining the process:
+   The documentation is included in the release you uploaded, but unfortunately its directory
structure is not quite right for the website. To get around this you need to unzip the `db-derby-x.y.z.w-bin.zip`
archive, rename some directories and copy the pdf files into the html hierarchy. Here is a
shell script outlining the process:
  
    {{{
  mkdir ~/x.y
@@ -473, +473 @@

  rmdir docs
  }}}
  
+   Pass in the location of the `db-derby-x.y.z.w-bin.zip`. Move the x.y directory that gets
created in your home directory over to `/www/db.apache.org/derby/docs`.
-   Pass in the location of the `db-derby-x.y.z.w-bin.zip`. Move the x.y directory that
- gets created in your home directory over to `/www/db.apache.org/derby/docs`.
  
-   (!) A recursive copy using scp is going to take a long time, so it is better to create
an archive and copy that:
+   (!) It is probably easier (especially if you have a high-latency connection to `people.apache.org`),
to create the x.y directory on the same machine where you built the release, but then you
need to upload the documention directory. A recursive copy using scp is going to take a long
time, so it is better to create an archive and copy that:
+ 
    {{{ zip -r x.y.zip x.y
  scp x.y.zip you@people.apache.org:/www/db.apache.org/derby/docs/
  ssh you@people.apache.org
@@ -487, +487 @@

   
   1. Create a page for the release, build/update site
  
-   For instructions on how to build the website using Forrest, please see: [http://db.apache.org/derby/papers/derby_web.html]
+   {i} For instructions on how to build the website using Forrest, please see: [http://db.apache.org/derby/papers/derby_web.html]
  
-  It is a good idea to use the previous release pages as templates, filling in the changed
details as necessary. You should add a .cgi and a .html file for the release. The main thing
to remember is that the .cgi file should have the same name as the .html file. 
+   (!) It is a good idea to use the previous release pages as templates, filling in the changed
details as necessary. 
+ 
+   You should add a .cgi and a .html file for the release. The main thing to remember is
that the .cgi file should have the same name as the .html file. 
  
    a. Update the derby_downloads.xml page in the src/documentation/content/xdocs directory
so that the links to the new files are included.
     Note the following things when creating the release page:
-   * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our usage
of ant tar to create this, using longfile=gnu for handling long filenames).
+    * Be sure to specify that the src.tar.gz requires gnu tar to unravel (because of our
usage of ant tar to create this, using longfile=gnu for handling long filenames).
-   * Forrest will not copy the release .cgi script over unless you make a link to it from
another page. Add the link to derby_downloads.html before building.
+    * Forrest will not copy the release .cgi script over unless you make a link to it from
another page. Add the link to derby_downloads.html before building.
-   * Remove all square brackets [] from the release notes page. When the cgi machinery sees
square brackets, it truncates the release page.
+    * Remove all square brackets [] from the release notes page. When the cgi machinery sees
square brackets, it truncates the release page.
-   * Make sure that the .cgi script is made executable by setting svn:executable on it with
{{{svn propset 
+    * Make sure that the .cgi script is made executable by setting svn:executable on it with
{{{svn propset 
  svn:executable ON release-10.1.2.1.cgi}}}. Be sure to do this for both the precursor version
you created in src/documentation/content/xdocs/releases and for the generated copy which forrest
builds into build/site/releases.
-   * In order for the release HTML file to be pulled into the build, it is necessary to add
a line to the <uris> section of src/documentation/conf/cli.xconf. Near line 310 of that
file, add: <uri type="append" src="releases/release-10.1.2.1.html"/> (with the correct
version for your release)
+    * In order for the release HTML file to be pulled into the build, it is necessary to
add a line to the <uris> section of src/documentation/conf/cli.xconf. Near line 310
of that file, add: <uri type="append" src="releases/release-10.1.2.1.html"/> (with the
correct version for your release)
-   * Svn delete the cgi script for the previous release. Also, edit its release page to remove
the cgi boilerplate and convert the distribution links from mirror references to ordinary
links. This means removing the [preferred] tags. To see what this should look like, look at
the release page for an even older release.
+    * Svn delete the cgi script for the previous release. Also, edit its release page to
remove the cgi boilerplate and convert the distribution links from mirror references to ordinary
links. This means removing the [preferred] tags. To see what this should look like, look at
the release page for an even older release.
-   * Subversion may report some files as changed which should be static. Revert anything
in build/site/skin or build/site/papers before committing your website changes ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs
see the explanation]).
+    * Subversion may report some files as changed which should be static. Revert anything
in build/site/skin or build/site/papers before committing your website changes ([http://db.apache.org/derby/papers/derby_web.html#odd_diffs
see the explanation]).
+ 
    a. Run 'forrest site' at the top of the site tree.
  
-    Due to [http://issues.apache.org/jira/browse/FOR-480]FOR-480, the release page will be
built into your $FORREST_HOME/main/site directory. You will need to copy it to the build directory.
+    {X} Due to [http://issues.apache.org/jira/browse/FOR-480 FOR-480], the release page will
be built into your `$FORREST_HOME/main/site` directory. You will need to copy it to the build
directory. The build process frequently will create "false modifications" in `build/tmp` or
`build/site/skin`. These must be reverted before checking in the changes.
  
-   a. Check the changes. If they look good, 'svn commit' them. NOTE: you should revert any
changed files in build/tmp or build/site/skin. But you should check in other updated files.
+    {{{cd webtrunk
+ rm -rf $FORREST_HOME/main/site/*  # Remove any files from a previous build
+ forrest site
+ cp -r $FORREST_HOME/main/site build/site
+ svn revert -R build/tmp build/site/skin
+ }}}
  
+   a. Check the changes. If they look good, 'svn commit' them.
+ 
-   a. Update the website on people.apache.org by logging into the machine and doing:
+   a. Update the website on `people.apache.org` by logging into the machine and doing:
  
     {{{cd /www/db.apache.org/derby
  svn up}}}
  
-    Note that people.apache.org is rsync'd to the actual website every hour or so. Verify
that the changes appear on the Derby website at http://db.apache.org/derby/derby_downloads.html
+    <!> Note that `people.apache.org` is rsync'd to the actual website every hour or
so. Verify that the new release appears on the [http://db.apache.org/derby/derby_downloads.html
Derby download page]. Also check you still can download any release for which you disabled
mirroring. Finally check that you can access the new documentation at the [http://db.apache.org/derby/manuals/index.html
documentation page].
  
-    Also, when you run 'svn up' on people.apache.org, make sure that the new .cgi file is
executable and otherwise has the correct permissions!
+    <!> Also, when you run 'svn up' on people.apache.org, make sure that the new .cgi
file is executable and otherwise has the correct permissions!
  
    a. Once you have committed your changes and updated the website on people, you can review
your changes by following the instructions at http://www.apache.org/dev/project-site.html
  

Mime
View raw message