Author: vgritsenko
Date: Wed Aug 8 18:05:29 2007
New Revision: 564064
URL: http://svn.apache.org/viewvc?view=rev&rev=564064
Log:
add site update instructions
Added:
xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml
(with props)
Modified:
xml/xindice/trunk/src/documentation/content/xdocs/dev/book.xml
xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml
Modified: xml/xindice/trunk/src/documentation/content/xdocs/dev/book.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/book.xml?view=diff&rev=564064&r1=564063&r2=564064
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/book.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/book.xml Wed Aug 8
18:05:29 2007
@@ -43,8 +43,9 @@
</menu>
<menu label="Documentation">
- <menu-item label="How To Contribute" href="doc-contributing.html"/>
<menu-item label="Xindice Internals" href="guide-internals.html"/>
- <menu-item label="Wiki" href="http://wiki.apache.org/xindice"/>
+ <menu-item label="Xindice Wiki" href="http://wiki.apache.org/xindice"/>
+ <menu-item label="Contributing Documentation"
href="doc-contributing.html"/>
+ <menu-item label="Updating Website" href="site-updating.html"/>
</menu>
</book>
Added: xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml?view=auto&rev=564064
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml
(added)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml Wed
Aug 8 18:05:29 2007
@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements. See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License. You may obtain a copy of the License at
+ -
+ - http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -
+ - $Id$
+ -->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN"
"document-v13.dtd">
+
+<!--
+ - Version: $Revision$ $Date$
+ - Author: Vadim Gritsenko ([EMAIL PROTECTED])
+ -->
+<document>
+ <header>
+ <title>How to update Xindice Website</title>
+ <version>$Revision$</version>
+ <authors>
+ <person name="Vadim Gritsenko" email="[EMAIL PROTECTED]"/>
+ </authors>
+ </header>
+
+ <body>
+ <section>
+ <title>Overview</title>
+ <p>
+ This document is intended to familiarize Xindice committers with
website
+ update procedure.
+ </p>
+ <p>
+ Xindice website documentation is written in XML documents and published
+ to the web by <link href="http://forrest.apache.org/";>Apache
Forrest</link>.
+ To update website, follow these simple steps:
+ </p>
+ <ul>
+ <li>Get Forrest.</li>
+ <li>Get <code>xml-site</code>.</li>
+ <li>Build website.</li>
+ <li>Commit to <link
href="http://svn.apache.org/repos/asf/xml/site/targets/xindice/";>xml-site</link>.</li>
+ <li>Sync people.apache.org.</li>
+ <li>Done!</li>
+ </ul>
+ <p>
+ These steps are covered in more details below. We assume that you
already have xml-xindice
+ checkout at <code>~/projects/xml-xindice</code>.
+ </p>
+ </section>
+
+ <section>
+ <title>Getting Forrest</title>
+ <p>
+ In the <code>~/projects</code> directory, execute:
+ </p>
+ <source>
+ $ svn co http://svn.apache.org/repos/asf/forrest/branches/forrest_08_branch/
forrest-0.8.x
+ $ cd forrest-0.8.x/main
+ $ build.sh</source>
+ <p>
+ After process is completed, you should see <code>BUILD
SUCCESSFUL</code> message.
+ </p>
+ </section>
+
+ <section>
+ <title>Getting <code>xml-site</code></title>
+ <p>
+ In the <code>~/projects</code> directory, execute:
+ </p>
+ <source>
+ $ svn co http://svn.apache.org/repos/asf/xml/site/ xml-site</source>
+ <p>
+ You can find html version of current Xindice website in
<code>/targets/xindice</code>
+ directory.
+ </p>
+ </section>
+
+ <section>
+ <title>Building Website</title>
+ <p>
+ In the xml-xindice directory, execute:
+ </p>
+ <source>
+ $ ~/projects/forrest-0.8.x/bin/forrest</source>
+ <p>
+ This will create html website at <code>build/site/</code>. Check
results with the browser
+ before proceeding.
+ </p>
+ </section>
+
+ <section>
+ <title>Committing Website</title>
+ <p>
+ In the xml-xindice directory, execute:
+ </p>
+ <source>
+ $ cp -r build/site/* ../xml-site/targets/xindice/
+ $ # Review results:
+ $ svn st ../xml-site/targets/xindice/
+ $ # svn add, if necessary
+ $ # svn diff, to verify changes
+ $ svn ci ../xml-site/targets/xindice/</source>
+ </section>
+
+ <section>
+ <title>Syncing Website</title>
+ <p>
+ Once website is checked in, it needs to be updated on
people.apache.org machine:
+ </p>
+ <source>
+ $ ssh <yourname>@people.apache.org
+ $ cd /www/xml.apache.org/xindice/
+ $ svn up</source>
+ </section>
+
+ <section>
+ <title>Done!</title>
+ <p>
+ Approximately in 4 hours (or less), your updates will appear at
+ <link
href="http://xml.apache.org/xindice";><code>http://xml.apache.org/xindice</code></link>.
+ </p>
+ </section>
+
+ </body>
+</document>
Propchange:
xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
xml/xindice/trunk/src/documentation/content/xdocs/dev/site-updating.xml
------------------------------------------------------------------------------
svn:keywords = Id Revision Author Date
Modified: xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml
URL:
http://svn.apache.org/viewvc/xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml?view=diff&rev=564064&r1=564063&r2=564064
==============================================================================
--- xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml (original)
+++ xml/xindice/trunk/src/documentation/content/xdocs/dev/todo.xml Wed Aug 8
18:05:29 2007
@@ -19,7 +19,7 @@
- $Id$
-->
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"document-v11.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"document-v13.dtd">
<!--
- Version: $Revision$ $Date$
@@ -59,7 +59,7 @@
<li>
<strong>Database Lock</strong> Place a lock on database files using
Java 1.4 APIs to prevent separate processes from working on the same
- database. [VG]
+ database.
</li>
<li>
<strong>WebAdmin</strong> Integrate new WebDAV capable WebAdmin into
