incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r331210 - in /incubator/public/trunk/site-author: guides/website.html howtoparticipate.html site.xml
Date Mon, 07 Nov 2005 05:30:33 GMT
Author: crossley
Date: Sun Nov  6 21:30:28 2005
New Revision: 331210

URL: http://svn.apache.org/viewcvs?rev=331210&view=rev
Log:
Start to improve the instructions for the top-level website.

Added:
    incubator/public/trunk/site-author/guides/website.html   (with props)
Modified:
    incubator/public/trunk/site-author/howtoparticipate.html
    incubator/public/trunk/site-author/site.xml

Added: incubator/public/trunk/site-author/guides/website.html
URL: http://svn.apache.org/viewcvs/incubator/public/trunk/site-author/guides/website.html?rev=331210&view=auto
==============================================================================
--- incubator/public/trunk/site-author/guides/website.html (added)
+++ incubator/public/trunk/site-author/guides/website.html Sun Nov  6 21:30:28 2005
@@ -0,0 +1,145 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<title>Updating the top-level website</title>
+</head>
+<body>
+
+<p>This section describes how to maintain the top-level Incubator
+website (including the project status reports).
+For actual project websites see the separate
+<a href="site:howtoparticipate">Project Website Howto</a>.
+However, this section is still relevant for projects.
+</p>
+
+<h1>Overview of the Incubator site</h1>
+<p>The top-level Incubator website is currently generated by
+              <a href="ext:apache/projects/forrest">Apache Forrest</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
+            </p>
+<p>
+            The production documents are kept in the "incubator" SVN repository
+            at "site-publish".
+            That directory is then checked-out on the server to re-create the website.
+            </p>
+
+<h1>Edit the content</h1>
+<p>People with commit access to the "incubator" SVN can edit the
+source documents in the "site-author/" directory. Anyone else can send
+patches to those documents.</p>
+
+<h2>Checkout the Incubator SVN</h2>
+<pre>
+cd /usr/local/svn
+svn co https://svn.apache.org/repos/asf/incubator/public/trunk incubator
+cd incubator
+</pre>
+
+<h2>Edit the source documents</h2>
+<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>
+
+<h2>Add a new document</h2>
+<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
+</p>
+
+<h2>Edit your project status report</h2>
+<p>
+The sources for the status reports are in site-author/projects/*.html
+</p>
+<p>
+Add a new one by copying the template from site-author/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/index.html
+</p>
+
+<h1>Generating the top-level website</h1>
+<p><b>Note:</b> You can just commit the source changes and leave it to
someone
+else to generate the website.
+</p>
+
+<h2>Using a local Forrest installation</h2>
+<p>
+Install this specific release of
+<a href="ext:apache/projects/forrest">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' to
+render the HTML and PDF files into "build/site" directory.
+<p>If the site built without errors, you now need to synch the
+<span class="codefrag">incubator/build/site</span> directory with the
+<span class="codefrag">incubator/site-publish</span> directory.</p>
+<pre class="code">
+cd incubator
+svn update
+diff -rq build/site site-publish | grep -v "\.svn"
+... Ensure that the differences are what you expect.
+
+cp -Rf build/site/* site-publish
+... Now do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'
+           </pre>
+
+<p>To update the website, the "incubator/site-publish"
+SVN directory is checked-out on the server.
+</p>
+<pre class="code">
+ssh www.apache.org
+cd /www/incubator.apache.org
+svn update
+</pre>
+      
+<h1><a name="other" />Other notes</h1>
+           <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
+           </p>
+           <p>
+             See other notes for maintenance of
+             <a href="http://www.apache.org/dev/project-site.html">project websites</a>.
+           </p>
+</body>
+</html>

Propchange: incubator/public/trunk/site-author/guides/website.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: incubator/public/trunk/site-author/howtoparticipate.html
URL: http://svn.apache.org/viewcvs/incubator/public/trunk/site-author/howtoparticipate.html?rev=331210&r1=331209&r2=331210&view=diff
==============================================================================
--- incubator/public/trunk/site-author/howtoparticipate.html (original)
+++ incubator/public/trunk/site-author/howtoparticipate.html Sun Nov  6 21:30:28 2005
@@ -9,7 +9,6 @@
       
 <h1>Check this first</h1>
          
-         
 <p>Before doing anything, we encourage you to read the incubator website and in particular
             our "About" documents.</p>
             
@@ -25,7 +24,7 @@
 <h1>Incubator Project resources</h1>
          
          
-<div class="fixme">nicolaken:
+<div class="fixme">fixme:
       Check that all Incubator project resources are listed.</div>
          
 <h2>Mailing lists</h2>
@@ -86,164 +85,6 @@
 	         
 </ul>
 
-        
-<h2>Updating the site</h2>
-<p>This section describes how to maintain the top-level Incubator
-            website (including the project status reports).
-            For actual project websites see the
-            <a href="#project-website">Project Website Howto</a> below.
-            However, this section is still relevant for projects.
-          </p>
-<h3>Overview</h3>
-<p>The top-level Incubator website is currently generated by
-              <a href="ext:apache/projects/forrest">Apache Forrest</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.
-            </p>
-<p>
-            The production documents are kept in the "incubator" SVN repository
-            at "site-publish".
-            That directory is then checked-out on the server to re-create the website.
-            </p>
-<h3>Edit the content</h3>
-<p>People with commit access to the "incubator" SVN can edit the
-            source documents in the "site-author/" directory. Anyone else can send
-            patches to those documents.</p>
-<p><b>Note:</b> You can just commit the source changes and leave it to
someone
-            else to generate the website.
-            </p>
-            <p>It is <b>strongly</b> suggested to use plain HTML for the
source files. 
-               Forrest understands them even if malformed, and generates the site
-               in any case. Use any HTML editor that you prefer, as long as it 
-               doesn't mess up too much with the source tags.</p>
-<p>You have a choice of source formats to use: plain HTML, the document-v* series of
xdocs,
-JSPWiki, others formats which we are not encouraging here. Keep it simple.</p>
-<p>When editing xml source, please ensure xml validation (forrest will).
-            When editing simple JSPWiki source, please take care to use
-            the correct syntax (forrest cannot).
-	          Here are examples of the source document structures:
-	          <a href="/">html format</a>
-                  and
-	          <a href="http://forrest.apache.org/docs/document-v12.html">xml format</a>
-	          and 
-	          <a href="http://forrest.apache.org/docs/wiki-sample.html">JSPWiki format</a>
-</p>
-<p>Note: Converting from wiki source to html source. A conversion run has been already
done.
-Do: cd site-author/projects; svn mv mine.cwiki mine.html' and then edit it to replace the
old content
-with that from projects/TEMP_HTML/mine.html</p>
-<h3>Generate the production documents</h3>
-<p>Either install Apache Forrest locally so that you can edit and
-            review documents immediately, or use the production system on
-            the server to generate and copy to a staging site to view them.
-            In the future there will be automated generation and staging systems.
-            </p>
-<p>Lets explain the server-side method first, then go on to explain
-             how to set up a local Forrest system.
-            </p>
-<p>People with access to the server can use an installation of
-              Forrest on minotaur ...
-            </p>
-<pre class="code">ssh www.apache.org
-cd ~crossley/incubator-site
-bash
-bin/stage incubator
-... This will do 'svn update' of "incubator" and build docs with Forrest.
-
-cp -R staging/incubator.apache.org ~/public_html
-... This will copy the production to your committer webspace for viewing.
-
-diff -rq staging/incubator.apache.org modules/incubator/site-publish \
- | grep -v "\.svn" &gt; diff
-vi diff
-... Ensure that the differences are what you expect.
-
-cp -Rf staging/incubator.apache.org/* modules/incubator/site-publish
-... Now do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'
-
-cd /www/incubator.apache.org
-svn update
-</pre>
-<h3>Using a local Forrest installation</h3>
-<p>
-              Install this specific release of
-              <a class="external" href="ext:apache/projects/forrest">Apache Forrest</a>
-              (v0.6 release or SVN branch "forrest_06_branch")
-              by following the instructions at the index.html in the
-              distribution, to set the environment variables
-              $FORREST_HOME and $PATH.
-            </p>
-            <p>
-              Note: We need to stick with an agreed version, because there
-              are potentially many people wanting to generate the site.
-            </p>
-<p>
-              Checkout the incubator SVN repository. The site source files are kept
-              in the "incubator" SVN at "site-author/". The final website contents are
-              kept in the "incubator" SVN at "site-publish/".
-            </p>
-<p>Edit the docs in the <span class="codefrag">site-author</span> directory.</p>
-<p>Here are examples of the document structures:
-	         <a href="http://forrest.apache.org/docs/document-v12.html">xml format</a>
-	         and 
-	         <a href="http://forrest.apache.org/docs/wiki-sample.html">JSPWiki format</a>.</p>
-<p>If you add a new page or change a page's name, update 
-	         <code>site-author/site.xml</code> from which the menu is generated.
-           More details can be found in the 
-	         <a href="http://forrest.apache.org/docs/">Forrest documentation</a>.</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 docs <strong>in place</strong> at <span class="codefrag">site-author/*.*</span>
-           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 "<span class="codefrag">incubator</span>" SVN directory,
-           do 'forrest' to
-           render the HTML and PDF files into "<span class="codefrag">build/site</span>".
-           Forrest validates the XML, so will catch any syntax errors.
-	         You can also simply validate the source xdocs without rendering
-           by doing 'forrest validate'.</p>
-<p>If the site built without errors, you now need to synch the
-           <span class="codefrag">incubator/build/site</span> directory with
the
-           <span class="codefrag">incubator/site-publish</span> directory.</p>
-<pre class="code">
-cd incubator
-svn update
-diff -rq build/site site-publish | grep -v "\.svn"
-... Ensure that the differences are what you expect.
-
-cp -Rf build/site/* site-publish
-... Now do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'
-           </pre>
-<p>If you are not an Incubator committer, then you can now make a
-           patch with the command 
-	         '<span class="codefrag">svn diff &gt; incubator-site.diff</span>'
in the
-           "<span class="codefrag">incubator/site-author/</span>" directory,
and submit it to the
-           mailing list, starting with '<span class="codefrag">[PATCH]</span>'
in the email
-           subject.</p>
-<p>To update the website, the "incubator/site-publish"
-             SVN directory is checked-out on the server.
-           </p>
-<pre class="code">
-ssh www.apache.org
-cd /www/incubator.apache.org
-svn update
-           </pre>
-      
-
-      
 <h1>Project-specific resources</h1>
          
          
@@ -289,5 +130,14 @@
              See other notes for maintenance of
              <a href="http://www.apache.org/dev/project-site.html">project websites</a>.
            </p>
+
+<h1><a name="www" />Updating the top-level website</h1>
+<p>How to maintain the top-level Incubator website (including the project status reports).
See the <a href="site:guides/website">website guide</a>.
+</p>
+<p>
+For actual project websites, see the
+<a href="#project-website">Project Website Howto</a> above.
+However, this section is still relevant for projects.
+</p>
 </body>
 </html>

Modified: incubator/public/trunk/site-author/site.xml
URL: http://svn.apache.org/viewcvs/incubator/public/trunk/site-author/site.xml?rev=331210&r1=331209&r2=331210&view=diff
==============================================================================
--- incubator/public/trunk/site-author/site.xml (original)
+++ incubator/public/trunk/site-author/site.xml Sun Nov  6 21:30:28 2005
@@ -22,6 +22,7 @@
     <chair label="Chair" href="chair.html"/>
     <pmc label="PMC" href="pmc.html"/>
     <projects label="Projects and Mentors" href="projects.html"/>
+    <website label="Updating the website" href="website.html"/>
   </guides>
 	
   <!-- 



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


Mime
View raw message