incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r373700 - in /incubator/public/trunk: site-author/guides/website.xml site-publish/guides/website.html
Date Tue, 31 Jan 2006 04:46:13 GMT
Author: crossley
Date: Mon Jan 30 20:46:07 2006
New Revision: 373700

URL: http://svn.apache.org/viewcvs?rev=373700&view=rev
Log:
Update the website instructions.

Modified:
    incubator/public/trunk/site-author/guides/website.xml
    incubator/public/trunk/site-publish/guides/website.html

Modified: incubator/public/trunk/site-author/guides/website.xml
URL: http://svn.apache.org/viewcvs/incubator/public/trunk/site-author/guides/website.xml?rev=373700&r1=373699&r2=373700&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/website.xml (original)
+++ incubator/public/trunk/site-author/guides/website.xml Mon Jan 30 20:46:07 2006
@@ -1,9 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <document>
-  <properties><!--
-
-    <meta content="HTML Tidy, see www.w3.org" name="generator"/>-->
-
+  <properties>
     <title>Updating the top-level website
 </title>
   </properties>
@@ -13,13 +10,12 @@
 </title>
       <p>The top-level Incubator website is currently generated by
 
-        <a href="http://forrest.apache.org/">Apache Forrest
+        <a href="http://jakarta.apache.org/velocity/docs/anakia.html">Apache Jakarta
Velocity Anakia
 </a>.
-
       </p>
       <p>The source documents are kept in the "incubator" SVN repository at
-"site-author". Most documents are in site-author/*.html format. The
-status reports for each project are in site-author/project/*.html
+"site-author". The
+status reports for each project are in site-author/project/
 </p>
       <p>The production documents are kept in the "incubator" SVN repository
 at "site-publish". That directory is then checked-out on the server
@@ -30,45 +26,40 @@
       <title>Edit the content
 </title>
       <p>People with commit access to the "incubator" SVN can edit the source
-documents in the "site-author/" directory. Anyone else can send
+documents in the "site-author" directory. Anyone else can send
 patches to those documents.
 </p>
       <section id="Checkout+the+Incubator+SVN">
         <title>Checkout the Incubator SVN
 </title>
-        <pre>cd /usr/local/svn svn co
-https://svn.apache.org/repos/asf/incubator/public/trunk incubator cd
-incubator
+        <pre>
+cd /usr/local/svn
+svn co https://svn.apache.org/repos/asf/incubator/public/trunk incubator
+cd incubator
 </pre>
       </section>
       <section id="Edit+the+source+documents">
         <title>Edit the source documents
 </title>
-        <p>The source content is in html format at "site-author" directory.
-Please edit it and view the html document directly in your web
-browser. Looks okay? Then do your normal svn procedure 'svn diff, svn
-commit' etc. Done.
-</p>
-        <p>Later someone will generate the documents with Forrest (see below).
+        <p>The source content is in Anakia xdoc format at "site-author" directory.
 </p>
       </section>
       <section id="Add+a+new+document">
         <title>Add a new document
 </title>
         <p>Add new documents in the site-author directory, then do 'svn add'.
-Add a new entry to the menu structure by editing site-author/site.xml
+Add a new entry to the menu structure by editing site-author/stylesheets/project.xml
 </p>
       </section>
       <section id="Edit+your+project+status+report">
         <title>Edit your project status report
 </title>
-        <p>The sources for the status reports are in site-author/projects/*.html
+        <p>The sources for the status reports are in site-author/projects/*.xml
 </p>
         <p>Add a new one by copying the template from
-site-author/projects/incubation-status-template.html to
-site-author/projects/${project}.html and follow the instructions
-above for adding a new document. Also add an entry to the table at
-site-author/projects/index.html
+site-author/projects/incubation-status-template.xml to
+site-author/projects/${project}.xml and doing 'svn add'.
+Also add an entry to the table at site-author/projects/index.xml
 </p>
       </section>
     </section>
@@ -78,75 +69,33 @@
       <p>
         <strong>Note:
 </strong>You can just commit the source changes and leave it to someone else
-to generate the website.
+to generate the website, however it is better to generate the site.
 
       </p>
-      <section id="Using+a+local+Forrest+installation">
-        <title>Using a local Forrest installation
-</title>
-        <p>Install this specific release of
-
-          <a href="http://forrest.apache.org/">Apache Forrest
-</a>(SVN branch "forrest_07_branch") ...
-
-        </p>
-        <pre>cd /usr/local/svn svn co
-http://svn.apache.org/repos/asf/forrest/branches/forrest_07_branch
-forrest_07_branch cd forrest_07_branch/main ./build.sh
-</pre>
-        <p>Set the JAVA_HOME environment variable (1.4+). For convenience, you
-can also set the FORREST_HOME environment variable to be the
-top-level of the distribution, and add $FORREST_HOME/bin to your
-$PATH.
-</p>
-        <p>Here is a quick tour:
-</p>
-        <ul>
-          <li>cd into the local "incubator" SVN directory.
-</li>
-          <li>Do 'forrest run'.
-</li>
-          <li>Browser http://localhost:8888/ to review the site.
-</li>
-          <li>Edit the source docs in place at site-author/*.* and see changes in
-the browser by re-loading the page.
-</li>
-        </ul>
-        <p>When you are satisifed, you will rebuild the whole site and add the
-changed documents to the "site-publish" directory ...
-</p>
-        <p>In the top-level "incubator" SVN directory, do 'forrest site' (or
-just plain 'forrest') to render the HTML and PDF files into the
+        <p>In the top-level "incubator" SVN directory, do 'ant'
+to render the HTML files into the
 "site-publish" directory. If the site built without errors, then do
 the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'.
 </p>
         <p>To update the website, the "incubator/site-publish" SVN directory is
 checked-out on the server.
 </p>
-        <pre class="code">ssh people.apache.org cd /www/incubator.apache.org svn update
+        <pre class="code">
+ssh people.apache.org
+cd /www/incubator.apache.org
+svn update
 </pre>
-      </section>
     </section>
     <section id="other">
       <title id="other">Other notes
 </title>
       <p>Make sure that your subversion client is properly
-
         <a href="http://www.apache.org/dev/version-control.html#https-svn">configured
-</a>. This vastly reduces the amount of traffic on the svn email commits,
-e.g. *.pdf
-
+</a>.
       </p>
       <p>See other notes for maintenance of
-
         <a href="http://www.apache.org/dev/project-site.html">project websites
 </a>.
-
-      </p>
-      <p>Note: temporary links to cause templates to be generated as xdoc ...
-
-        <a href="../projects/incubation-status-template.html"/>
-        <a href="../ip-clearance/ip-clearance-template.html"/>
       </p>
     </section>
   </body>

Modified: incubator/public/trunk/site-publish/guides/website.html
URL: http://svn.apache.org/viewcvs/incubator/public/trunk/site-publish/guides/website.html?rev=373700&r1=373699&r2=373700&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/website.html (original)
+++ incubator/public/trunk/site-publish/guides/website.html Mon Jan 30 20:46:07 2006
@@ -92,13 +92,12 @@
 
 <p>The top-level Incubator website is currently generated by
 
-        <a href="http://forrest.apache.org/">Apache Forrest
+        <a href="http://jakarta.apache.org/velocity/docs/anakia.html">Apache Jakarta
Velocity Anakia
 </a>.
-
       </p>
 <p>The source documents are kept in the "incubator" SVN repository at
-"site-author". Most documents are in site-author/*.html format. The
-status reports for each project are in site-author/project/*.html
+"site-author". The
+status reports for each project are in site-author/project/
 </p>
 <p>The production documents are kept in the "incubator" SVN repository
 at "site-publish". That directory is then checked-out on the server
@@ -117,7 +116,7 @@
 
 
 <p>People with commit access to the "incubator" SVN can edit the source
-documents in the "site-author/" directory. Anyone else can send
+documents in the "site-author" directory. Anyone else can send
 patches to those documents.
 </p>
 <h3>
@@ -131,9 +130,10 @@
 
 
 
-<pre>cd /usr/local/svn svn co
-https://svn.apache.org/repos/asf/incubator/public/trunk incubator cd
-incubator
+<pre>
+cd /usr/local/svn
+svn co https://svn.apache.org/repos/asf/incubator/public/trunk incubator
+cd incubator
 </pre>
 </div>
 <h3>
@@ -147,12 +147,7 @@
 
 
 
-<p>The source content is in html format at "site-author" directory.
-Please edit it and view the html document directly in your web
-browser. Looks okay? Then do your normal svn procedure 'svn diff, svn
-commit' etc. Done.
-</p>
-<p>Later someone will generate the documents with Forrest (see below).
+<p>The source content is in Anakia xdoc format at "site-author" directory.
 </p>
 </div>
 <h3>
@@ -167,7 +162,7 @@
 
 
 <p>Add new documents in the site-author directory, then do 'svn add'.
-Add a new entry to the menu structure by editing site-author/site.xml
+Add a new entry to the menu structure by editing site-author/stylesheets/project.xml
 </p>
 </div>
 <h3>
@@ -181,13 +176,12 @@
 
 
 
-<p>The sources for the status reports are in site-author/projects/*.html
+<p>The sources for the status reports are in site-author/projects/*.xml
 </p>
 <p>Add a new one by copying the template from
-site-author/projects/incubation-status-template.html to
-site-author/projects/${project}.html and follow the instructions
-above for adding a new document. Also add an entry to the table at
-site-author/projects/index.html
+site-author/projects/incubation-status-template.xml to
+site-author/projects/${project}.xml and doing 'svn add'.
+Also add an entry to the table at site-author/projects/index.xml
 </p>
 </div>
 </div>
@@ -205,63 +199,23 @@
 <p>
         <strong>Note:
 </strong>You can just commit the source changes and leave it to someone else
-to generate the website.
+to generate the website, however it is better to generate the site.
 
       </p>
-<h3>
-   <a name="Using+a+local+Forrest+installation">Using a local Forrest installation
-</a>
-</h3>
-<div class="section-content">
-
-
-
-
-
-
-<p>Install this specific release of
-
-          <a href="http://forrest.apache.org/">Apache Forrest
-</a>(SVN branch "forrest_07_branch") ...
-
-        </p>
-<pre>cd /usr/local/svn svn co
-http://svn.apache.org/repos/asf/forrest/branches/forrest_07_branch
-forrest_07_branch cd forrest_07_branch/main ./build.sh
-</pre>
-<p>Set the JAVA_HOME environment variable (1.4+). For convenience, you
-can also set the FORREST_HOME environment variable to be the
-top-level of the distribution, and add $FORREST_HOME/bin to your
-$PATH.
-</p>
-<p>Here is a quick tour:
-</p>
-<ul>
-          <li>cd into the local "incubator" SVN directory.
-</li>
-          <li>Do 'forrest run'.
-</li>
-          <li>Browser http://localhost:8888/ to review the site.
-</li>
-          <li>Edit the source docs in place at site-author/*.* and see changes in
-the browser by re-loading the page.
-</li>
-        </ul>
-<p>When you are satisifed, you will rebuild the whole site and add the
-changed documents to the "site-publish" directory ...
-</p>
-<p>In the top-level "incubator" SVN directory, do 'forrest site' (or
-just plain 'forrest') to render the HTML and PDF files into the
+<p>In the top-level "incubator" SVN directory, do 'ant'
+to render the HTML files into the
 "site-publish" directory. If the site built without errors, then do
 the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'.
 </p>
 <p>To update the website, the "incubator/site-publish" SVN directory is
 checked-out on the server.
 </p>
-<pre class="code">ssh people.apache.org cd /www/incubator.apache.org svn update
+<pre class="code">
+ssh people.apache.org
+cd /www/incubator.apache.org
+svn update
 </pre>
 </div>
-</div>
            <h2><img src="/images/redarrow.gif" />
    <a name="other">Other notes
 </a>
@@ -274,22 +228,12 @@
 
 
 <p>Make sure that your subversion client is properly
-
         <a href="http://www.apache.org/dev/version-control.html#https-svn">configured
-</a>. This vastly reduces the amount of traffic on the svn email commits,
-e.g. *.pdf
-
+</a>.
       </p>
 <p>See other notes for maintenance of
-
         <a href="http://www.apache.org/dev/project-site.html">project websites
 </a>.
-
-      </p>
-<p>Note: temporary links to cause templates to be generated as xdoc ...
-
-        <a href="../projects/incubation-status-template.html" />
-        <a href="../ip-clearance/ip-clearance-template.html" />
       </p>
 </div>
          </td>



---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@incubator.apache.org
For additional commands, e-mail: cvs-help@incubator.apache.org


Mime
View raw message