lucene-java-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Lucene-java Wiki] Update of "HowToUpdateTheWebsite" by MikeMcCandless
Date Wed, 15 Oct 2008 15:27:31 GMT
Dear Wiki user,

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

The following page has been changed by MikeMcCandless:
http://wiki.apache.org/lucene-java/HowToUpdateTheWebsite

The comment on the change is:
Describe the unversioned & versioned sites

------------------------------------------------------------------------------
  
  ('''NOTE:''' ''You need committer rights to modify the Lucene Website.'')
  
+ There are two separate subversion repositories that hold the content for the Lucene java
website at http://lucene.apache.org/java/docs.
+ 
+ First is the unversioned files at https://svn.apache.org/repos/asf/lucene/java/site, which
contains all files under http://lucene.apache.org/java/docs.
+ 
+ Second is https://svn.apache.org/repos/asf/lucene/java/site, which contains files versioned
along with every release of Lucene java.  These appear under the release dir, eg http://lucene.apache.org/java/2_4_0,
as created during the release process (see ReleaseTodo).  This site is also pushed nightly
to http://lucene.apache.org/java/docs/nightly.
+ 
+ Both of these sites are generated using [http://forrest.apache.org/ Apache Forrest].  To
make a change to these sites:
+ 
     1. Install [http://forrest.apache.org/ Apache Forrest] version 0.8
+    1. Checkout the content (see above for the subversion url to use).
+    1. Change the root forrest directory.  For the versioned site, this is lucene/src/site;
for the unversioned site, it's main directory you just checked out.
+    1. Make your desired website changes to the source files in the subdirectory src/documentation.
-    1. Checkout the Lucene code.
-    1. Go to lucene/src/site
-    1. Run forrest to build current version of documentation to make sure that Forrest was
correctly installed. The generated site will be in lucene/src/site/build/site/.
-    1. Make your desired website changes to the source files in lucene/src/site/src and regenerate
the site with forrest.
-    1. Run "forrest run" and browse to http://localhost:8888 to review the changes. You should
be able to modify the source documents and hit reload on your browser without rebuilding the
site.
+    1. Optionally, run "forrest run" and browse to http://localhost:8888 to review the changes
and iterate.  You should be able to modify the source documents and hit reload on your browser
to see the changes.
-    1. When you are satisfied with your changes, regenerate the site with forrest by running
"forrest site", (recursively) copy lucene/src/site/build/site/* to lucene/docs/, and commit
changes to both lucene/src/site/src and lucene/docs (add any new files first, but exclude
the build directory).
-    1. The site will automatically be exported from svn by a script running in Grant's crontab
on p.a.o.
+    1. When you are satisfied with your changes, stop the forrest server and then regenerate
the site with forrest by running "forrest site".  Then, recursively copy build/site/* to ../../docs/*
(for the versioned site) and docs/* (for the unversioned site), and commit changes to both
src/documentation and docs (add any new files first, but exclude the build directory).
+    1. The site will automatically be exported from svn to people.apache.org by a script
running in Grant's crontab on p.a.o., and then Apache's main web servers will reflect the
change within an hour according to the process described at http://www.apache.org/dev/project-site.html).
 Grant's cron job currently (as of 10/15/2008) looks like this:
+ {{{
+ #!/bin/sh
+ /usr/local/bin/svn export --force http://svn.apache.org/repos/asf/lucene/java/site/docs
/www/lucene.apache.org/java/docs
+ /usr/local/bin/svn export --force http://svn.apache.org/repos/asf/lucene/java/trunk/docs
/www/lucene.apache.org/java/docs/nightly
+ }}}
  

Mime
View raw message