Author: crossley
Date: Tue Sep 21 00:25:07 2004
New Revision: 46969
Modified:
incubator/public/trunk/site-author/howtoparticipate.xml
incubator/public/trunk/site-publish/howtoparticipate.html
incubator/public/trunk/site-publish/howtoparticipate.pdf
Log:
Reflect the move from CVS to SVN.
Modified: incubator/public/trunk/site-author/howtoparticipate.xml
==============================================================================
--- incubator/public/trunk/site-author/howtoparticipate.xml (original)
+++ incubator/public/trunk/site-author/howtoparticipate.xml Tue Sep 21
00:25:07 2004
@@ -94,21 +94,23 @@
<p>The top-level Incubator website is currently generated by
<link href="ext:apache/projects/forrest">Apache Forrest</link>.
</p>
- <p>The source documents are kept in the "incubator" CVS module.
- Most documents are in site/*.xml format. The status reports for
- each project are in site/project/*.cwiki (this is the simple
JSPWiki
- format).
+ <p>The source documents are kept in the "incubator" SVN repository
+ at "site-author".
+ Most documents are in site-author/*.xml format.
+ The status reports for each project are in
site-author/project/*.cwiki
+ (this is the simple JSPWiki format).
</p>
<p>
- The production documents are kept in the "incubator-site" CVS
module.
- That module is then checked-out on the server to re-create the
website.
+ 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>
</section>
<section id="website-edit">
<title>Edit the content</title>
- <p>People with commit access to the "incubator" CVS can edit the
- source documents in the "site/" directory. Anyone else can send
+ <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>When editing the xml source, please ensure xml validation.
When editing the simple JSPWiki source, please take care to use
@@ -139,22 +141,21 @@
cd ~crossley/incubator-site
bash
bin/stage incubator
-... This will do 'cvs checkout' of "incubator" CVS and build docs with Forrest.
+... 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.
-cvs -q update -Pd modules/incubator-site
-diff -rq staging/incubator.apache.org modules/incubator-site/build/site \
- | grep -v CVS > diff
+diff -rq staging/incubator.apache.org modules/incubator/site-publish \
+ | grep -v "\.svn" > diff
vi diff
... Ensure that the differences are what you expect.
-cp -Rf staging/incubator.apache.org/* modules/incubator-site/build/site
-... Now do the usual CVS stuff: 'cvs update' 'cvs add' 'cvs diff' 'cvs commit'
+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
-cvs update -Pd
+svn update
]]></source>
</section>
@@ -169,12 +170,12 @@
$FORREST_HOME and $PATH.
</p>
<p>
- Checkout the incubator CVS modules. The site source files are
kept
- in the "incubator" CVS at "site/". The final website contents are
- kept in the "incubator-site" CVS at "build/site/".
+ 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 <code>incubator/site/</code>
directory.</p>
+ <p>Edit the docs in the <code>site-author</code> directory.</p>
<p>Here are examples of the document structures:
<link
href="http://forrest.apache.org/docs/document-v12.html";>xml format</link>
@@ -182,24 +183,25 @@
<link
href="http://forrest.apache.org/docs/wiki-sample.html";>JSPWiki
format</link>.</p>
<p>If you add a new page or change a page's name, update
- <code>site/site.xml</code> from which the menu is generated.
+ <code>site-author/site.xml</code> from which the menu is
generated.
More details can be found in the
<link href="http://forrest.apache.org/docs/";>Forrest
documentation</link>.</p>
<p>Here is a quick tour:</p>
<ul>
- <li>cd into the local "incubator" CVS dir.</li>
+ <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
<code>site/*.*</code>
+ <li>Edit the docs <strong>in place</strong> at
<code>site-author/*.*</code>
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 "incubator-site" CVS.
+ add the changed documents to the "site-publish" directory ...
</p>
- <p>In the "<code>incubator</code>" directory, do 'forrest' to
+ <p>In the top-level "<code>incubator</code>" SVN directory,
+ do 'forrest' to
render the HTML and PDF files into "<code>build/site</code>".
Forrest validates the XML, so will catch any syntax errors.
You can also simply validate the source xdocs without rendering
@@ -207,34 +209,31 @@
<p>If the site built without errors, you now need to synch the
<code>incubator/build/site</code> directory with the
- <code>incubator-site/build/site</code> directory.</p>
+ <code>incubator/site-publish</code> directory.</p>
<source>
-cvs -q update -Pd incubator-site
-diff -rq incubator/build/site incubator-site/build/site | grep -v CVS
+cd incubator
+svn update
+diff -rq build/site site-publish | grep -v "\.svn"
... Ensure that the differences are what you expect.
-cp -Rf incubator/build/site/* incubator-site/build/site
-... Now do the usual CVS stuff: 'cvs update' 'cvs add' 'cvs diff' 'cvs commit'
+cp -Rf build/site/* site-publish
+... Now do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'
</source>
- <p>Another way to do this is to use the <code>build.xml</code>
- script by invoking Ant "syncsite" task. Do 'ant' in the
top-level
- "incubator" directory.</p>
-
<p>If you are not an Incubator committer, then you can now
make a
patch with the command
- '<code>cvs diff -u > incubator-site.diff</code>' in the
- "<code>incubator-site/</code>" directory, and submit it to the
+ '<code>svn diff > incubator-site.diff</code>' in the
+ "<code>incubator/site-author/</code>" directory, and submit it to
the
mailing list, starting with '<code>[PATCH]</code>' in the email
subject.</p>
- <p>To update the website, the "incubator-site" CVS module is
- checked-out on the server.
+ <p>To update the website, the "incubator/site-publish"
+ SVN directory is checked-out on the server.
</p>
<source>
ssh www.apache.org
cd /www/incubator.apache.org
-cvs update -Pd
+svn update
</source>
</section>
</section>
Modified: incubator/public/trunk/site-publish/howtoparticipate.html
==============================================================================
--- incubator/public/trunk/site-publish/howtoparticipate.html (original)
+++ incubator/public/trunk/site-publish/howtoparticipate.html Tue Sep 21
00:25:07 2004
@@ -428,21 +428,23 @@
<p>The top-level Incubator website is currently generated by
<a class="external" href="http://forrest.apache.org/";>Apache
Forrest</a>.
</p>
-<p>The source documents are kept in the "incubator" CVS module.
- Most documents are in site/*.xml format. The status reports for
- each project are in site/project/*.cwiki (this is the simple
JSPWiki
- format).
+<p>The source documents are kept in the "incubator" SVN repository
+ at "site-author".
+ Most documents are in site-author/*.xml format.
+ The status reports for each project are in
site-author/project/*.cwiki
+ (this is the simple JSPWiki format).
</p>
<p>
- The production documents are kept in the "incubator-site" CVS
module.
- That module is then checked-out on the server to re-create the
website.
+ 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>
</div>
<a name="N100B4"></a><a name="website-edit"></a>
<h5>Edit the content</h5>
<div style="margin-left: 0 ; border: 2px">
-<p>People with commit access to the "incubator" CVS can edit the
- source documents in the "site/" directory. Anyone else can send
+<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>When editing the xml source, please ensure xml validation.
When editing the simple JSPWiki source, please take care to use
@@ -473,22 +475,21 @@
cd ~crossley/incubator-site
bash
bin/stage incubator
-... This will do 'cvs checkout' of "incubator" CVS and build docs with Forrest.
+... 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.
-cvs -q update -Pd modules/incubator-site
-diff -rq staging/incubator.apache.org modules/incubator-site/build/site \
- | grep -v CVS > diff
+diff -rq staging/incubator.apache.org modules/incubator/site-publish \
+ | grep -v "\.svn" > diff
vi diff
... Ensure that the differences are what you expect.
-cp -Rf staging/incubator.apache.org/* modules/incubator-site/build/site
-... Now do the usual CVS stuff: 'cvs update' 'cvs add' 'cvs diff' 'cvs commit'
+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
-cvs update -Pd
+svn update
</pre>
</div>
<a name="N100E0"></a><a name="forrest"></a>
@@ -503,80 +504,79 @@
$FORREST_HOME and $PATH.
</p>
<p>
- Checkout the incubator CVS modules. The site source files are
kept
- in the "incubator" CVS at "site/". The final website contents are
- kept in the "incubator-site" CVS at "build/site/".
+ 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">incubator/site/</span>
directory.</p>
+<p>Edit the docs in the <span class="codefrag">site-author</span>
directory.</p>
<p>Here are examples of the document structures:
<a class="external"
href="http://forrest.apache.org/docs/document-v12.html";>xml format</a>
and
<a class="external"
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
- <span class="codefrag">site/site.xml</span> from which the
menu is generated.
+ <span class="codefrag">site-author/site.xml</span> from which
the menu is generated.
More details can be found in the
<a class="external"
href="http://forrest.apache.org/docs/";>Forrest documentation</a>.</p>
<p>Here is a quick tour:</p>
<ul>
-<li>cd into the local "incubator" CVS dir.</li>
+<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/*.*</span>
+<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 "incubator-site" CVS.
+ add the changed documents to the "site-publish" directory ...
</p>
-<p>In the "<span class="codefrag">incubator</span>" directory, do 'forrest' to
+<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/build/site</span>
directory.</p>
+ <span class="codefrag">incubator/site-publish</span> directory.</p>
<pre class="code">
-cvs -q update -Pd incubator-site
-diff -rq incubator/build/site incubator-site/build/site | grep -v CVS
+cd incubator
+svn update
+diff -rq build/site site-publish | grep -v "\.svn"
... Ensure that the differences are what you expect.
-cp -Rf incubator/build/site/* incubator-site/build/site
-... Now do the usual CVS stuff: 'cvs update' 'cvs add' 'cvs diff' 'cvs commit'
+cp -Rf build/site/* site-publish
+... Now do the usual SVN stuff: 'svn status' 'svn add' 'svn diff' 'svn commit'
</pre>
-<p>Another way to do this is to use the <span class="codefrag">build.xml</span>
- script by invoking Ant "syncsite" task. Do 'ant' in the
top-level
- "incubator" directory.</p>
<p>If you are not an Incubator committer, then you can now make a
patch with the command
- '<span class="codefrag">cvs diff -u >
incubator-site.diff</span>' in the
- "<span class="codefrag">incubator-site/</span>" directory, and
submit it to the
+ '<span class="codefrag">svn diff >
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" CVS module is
- checked-out on the server.
+<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
-cvs update -Pd
+svn update
</pre>
</div>
</div>
</div>
-<a name="N10158"></a><a name="project"></a>
+<a name="N10152"></a><a name="project"></a>
<h3>Project-specific resources</h3>
<div style="margin-left: 0 ; border: 2px">
<p>Some <a href="projects/">projects</a> under incubation have their own
mailing lists,
or their development discussion occurs on the mailing list of another
project. Check out
the project websites to be sure what mailing list is the right
one.</p>
-<a name="N10165"></a><a name="project-website"></a>
+<a name="N1015F"></a><a name="project-website"></a>
<h4>Project Website Howto</h4>
<div style="margin-left: 0 ; border: 2px">
<p>Each project can use whatever documentation system that it
Modified: incubator/public/trunk/site-publish/howtoparticipate.pdf
==============================================================================
Binary files. No diff available.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
