You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by jt...@apache.org on 2006/10/18 21:10:18 UTC
svn commit: r465341 - in /db/derby/site/trunk:
build/site/papers/derby_web.html
src/documentation/content/xdocs/papers/derby_web.xml
Author: jta
Date: Wed Oct 18 12:10:17 2006
New Revision: 465341
URL: http://svn.apache.org/viewvc?view=rev&rev=465341
Log:
More updates to instructions for building the Derby web site:
1) Featured the Forrest tutorial.
2) Minor note to upload patches to Jira.
Modified:
db/derby/site/trunk/build/site/papers/derby_web.html
db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml
Modified: db/derby/site/trunk/build/site/papers/derby_web.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/papers/derby_web.html?view=diff&rev=465341&r1=465340&r2=465341
==============================================================================
--- db/derby/site/trunk/build/site/papers/derby_web.html (original)
+++ db/derby/site/trunk/build/site/papers/derby_web.html Wed Oct 18 12:10:17 2006
@@ -323,7 +323,11 @@
<a name="N100B5"></a><a name="Create+a+Forrest+seed+site"></a>
<h3 class="boxed">Create a Forrest seed site</h3>
<p>
-To get started with learning Forrest:
+The
+<em><a class="external" href="http://forrest.apache.org/docs_0_70/your-project.html">Using Forrest:
+A tutorial on how to use Forrest in your own projects</a></em> guide
+provides an excellent overview of Forrest.
+Below are some simple steps to get started:
</p>
<ul>
@@ -334,8 +338,7 @@
<li>
<a class="external" href="http://forrest.apache.org/docs_0_70/your-project.html#installing">Install Forrest and set up your environment</a>. </li>
-<li>
-<span class="codefrag">cd</span> into the directory of your choice
+<li> Create a new directory, <span class="codefrag">cd</span> into it,
and enter '<span class="codefrag">forrest seed</span>' to initialize a new project.
</li>
@@ -349,7 +352,7 @@
<li> Look at the sample pages that are included in the seed site.</li>
</ul>
-<a name="N100E8"></a><a name="Add+your+new+page+to+the+seed+site"></a>
+<a name="N100ED"></a><a name="Add+your+new+page+to+the+seed+site"></a>
<h3 class="boxed">Add your new page to the seed site</h3>
<p>
If you don't need to add a new page, skip this step.
@@ -439,7 +442,7 @@
source file. </li>
</ul>
-<a name="N1014B"></a><a name="What+editor+can+you+use+for+Forrest+XML%3F"></a>
+<a name="N10150"></a><a name="What+editor+can+you+use+for+Forrest+XML%3F"></a>
<h3 class="boxed">What editor can you use for Forrest XML?</h3>
<p>
The Forrest web site mentions jEdit, oXygen, xmlspy,
@@ -470,7 +473,7 @@
by posting to
<a href="../derby_mail.html">derby-dev@db.apache.org</a>.
</p>
-<a name="N10175"></a><a name="Resolve+Forrest+DTDs+locally"></a>
+<a name="N1017A"></a><a name="Resolve+Forrest+DTDs+locally"></a>
<h3 class="boxed">Resolve Forrest DTDs locally</h3>
<p>
Many source files in the Derby web site repository are in Forrest XML format.
@@ -503,7 +506,7 @@
-<a name="N10194"></a><a name="Updating+the+Apache+Derby+web+site"></a>
+<a name="N10199"></a><a name="Updating+the+Apache+Derby+web+site"></a>
<h2 class="boxed">Updating the Apache Derby web site </h2>
<div class="section">
<p>
@@ -513,14 +516,14 @@
Step 7 tells contributors how to create a patch.
Steps 8-10 tell committers how to commit and publish changes.
</p>
-<a name="N1019D"></a><a name="1.+Install+Forrest+on+your+machine"></a>
+<a name="N101A2"></a><a name="1.+Install+Forrest+on+your+machine"></a>
<h3 class="boxed">1. Install Forrest on your machine</h3>
<p>
If you haven't installed Forrest yet,
<a class="external" href="http://forrest.apache.org/mirrors.cgi">install Forrest 0.7</a>
on your local system.
</p>
-<a name="N101AB"></a><a name="2.+Check+out+the+Derby+web+site+pages"></a>
+<a name="N101B0"></a><a name="2.+Check+out+the+Derby+web+site+pages"></a>
<h3 class="boxed">2. Check out the Derby web site pages </h3>
<p>
Check the Derby web site files out of the subversion repository:
@@ -528,7 +531,7 @@
<pre class="code">
svn co https://svn.apache.org/repos/asf/db/derby/site/trunk
</pre>
-<a name="N101B9"></a><a name="3.+Modify+files+in+the+src+tree"></a>
+<a name="N101BE"></a><a name="3.+Modify+files+in+the+src+tree"></a>
<h3 class="boxed">3. Modify files in the src tree </h3>
<p>
After checking the site out of subversion,
@@ -685,7 +688,7 @@
</li>
</ul>
-<a name="N102CE"></a><a name="4.+Build+the+site"></a>
+<a name="N102D3"></a><a name="4.+Build+the+site"></a>
<h3 class="boxed">4. Build the site </h3>
<p>
After modifying files, rebuild the site with the
@@ -707,7 +710,7 @@
try setting the <span class="codefrag">ANT_OPTS</span> environment variable to
<span class="codefrag">-mx512M</span>.
</p>
-<a name="N102F7"></a><a name="5.+Test+the+changes"></a>
+<a name="N102FC"></a><a name="5.+Test+the+changes"></a>
<h3 class="boxed">5. Test the changes </h3>
<p>
There are a couple ways (at least) to review changes.
@@ -744,7 +747,7 @@
won't be added when the site is viewed locally.</a>
</p>
-<a name="N1032C"></a><a name="odd_diffs"></a>
+<a name="N10331"></a><a name="odd_diffs"></a>
<h3 class="boxed">6. Odd diffs under build/site/skin and build/site/papers explained (sort of) </h3>
<p>
Forrest generates inconsistent line endings on Windows machines
@@ -772,14 +775,17 @@
<a href="../derby_mail.html">derby-dev@db.apache.org</a>
if a particular file should be committed or not.
</p>
-<a name="N1035D"></a><a name="7.+Create+a+patch"></a>
+<a name="N10362"></a><a name="7.+Create+a+patch"></a>
<h3 class="boxed">7. Create a patch</h3>
<p>
Create a patch at the <span class="codefrag">trunk</span> level and only include the
<span class="codefrag">src</span> directory, as shown below:
</p>
<pre class="code">svn diff src > changes.diff</pre>
-<a name="N10371"></a><a name="8.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
+<p>
+Upload the patch to a Jira issue to make it available to a Derby committer.
+</p>
+<a name="N10379"></a><a name="8.+Commit+changes+to+the+src+and+build%2Fsite+directories"></a>
<h3 class="boxed">8. Commit changes to the src and build/site directories</h3>
<p>
Apply any patch, if one was provided, then build and test the web site
@@ -824,7 +830,7 @@
<pre class="code">
svn commit --message "here is my commit message" src build/site
</pre>
-<a name="N103B9"></a><a name="9.+Make+web+site+changes+visible"></a>
+<a name="N103C1"></a><a name="9.+Make+web+site+changes+visible"></a>
<h3 class="boxed">9. Make web site changes visible</h3>
<p>
A Derby committer can make web site changes visible as follows:
@@ -838,7 +844,7 @@
www.apache.org automatically syncs up with people.apache.org every couple hours
(the specific schedule could change).
</p>
-<a name="N103CD"></a><a name="10.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
+<a name="N103D5"></a><a name="10.+Considering+a+quick+fix+to+the+build+tree%3F"></a>
<h3 class="boxed">10. Considering a quick fix to the build tree?</h3>
<p>
If you modify a file in the <span class="codefrag">build/site</span> tree,
@@ -847,7 +853,7 @@
will likely overwrite your changes to the build tree.
</p>
<p>
-<em>Last updated Oct 17, 2006</em>
+<em>Last updated Oct 18, 2006</em>
</p>
</div>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml?view=diff&rev=465341&r1=465340&r2=465341
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/papers/derby_web.xml Wed Oct 18 12:10:17 2006
@@ -164,14 +164,18 @@
<section>
<title>Create a Forrest seed site</title>
<p>
-To get started with learning Forrest:
+The
+<em><a href="http://forrest.apache.org/docs_0_70/your-project.html">Using Forrest:
+A tutorial on how to use Forrest in your own projects</a></em> guide
+provides an excellent overview of Forrest.
+Below are some simple steps to get started:
</p>
<ul>
<li> <a href="http://forrest.apache.org/mirrors.cgi">Download</a>
Forrest 0.7. </li>
<li> <a href="http://forrest.apache.org/docs_0_70/your-project.html#installing">Install Forrest and set up your environment</a>. </li>
- <li> <code>cd</code> into the directory of your choice
+ <li> Create a new directory, <code>cd</code> into it,
and enter '<code>forrest seed</code>' to initialize a new project.
</li>
<li> Enter 'forrest site' to build the site. </li>
@@ -612,6 +616,10 @@
<source>svn diff src > changes.diff</source>
+<p>
+Upload the patch to a Jira issue to make it available to a Derby committer.
+</p>
+
</section>
<section>
@@ -699,7 +707,7 @@
</section>
-<p><em>Last updated Oct 17, 2006</em></p>
+<p><em>Last updated Oct 18, 2006</em></p>
</section>
</body>