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/03/04 00:35:49 UTC
svn commit: r382967 - in /db/derby/site/trunk: build/site/derby_comm.html
src/documentation/content/xdocs/derby_comm.xml
Author: jta
Date: Fri Mar 3 15:35:47 2006
New Revision: 382967
URL: http://svn.apache.org/viewcvs?rev=382967&view=rev
Log:
Modified the "Apache Derby: Get Involved!" page:
(1) Updated references since graduation into the DB Project
(2) Added "Communication Channels" subsection based on thread that started at
http://mail-archives.apache.org/mod_mbox/db-derby-dev/200602.mbox/%3c43FF5559.5020305@bristowhill.com%3e
(3) Added Derby Wiki links for new developers
Modified:
db/derby/site/trunk/build/site/derby_comm.html
db/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml
Modified: db/derby/site/trunk/build/site/derby_comm.html
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/build/site/derby_comm.html?rev=382967&r1=382966&r2=382967&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/derby_comm.html (original)
+++ db/derby/site/trunk/build/site/derby_comm.html Fri Mar 3 15:35:47 2006
@@ -107,6 +107,9 @@
<a href="#Provide+Feedback">Provide Feedback</a>
</li>
<li>
+<a href="#Communication+Channels">Communication Channels</a>
+</li>
+<li>
<a href="#Contribute+Code+or+Documentation">Contribute Code or Documentation</a>
</li>
</ul>
@@ -134,7 +137,7 @@
</li>
<li>
- Participate in the <a class="external" href="http://wiki.apache.org/db-derby">Derby Wiki</a>.
+ Add your wisdom to the <a class="external" href="http://wiki.apache.org/db-derby">Derby Wiki</a>.
</li>
@@ -162,14 +165,49 @@
</div>
-<a name="N10040"></a><a name="Contribute+Code+or+Documentation"></a>
-<h2 class="boxed">Contribute Code or Documentation</h2>
+<a name="N10040"></a><a name="Communication+Channels"></a>
+<h2 class="boxed">Communication Channels</h2>
<div class="section">
-<p>
+<p>
+The primary mechanism for Derby communication is
+the <a href="derby_mail.html">Derby mail lists</a>.
+Anyone can participate, no matter what their time zone. The ASF
+maintains a reliable searchable archive of past discussions. Oversight
+is enabled. Many eyes ensures that the project evolves in a consistent
+direction.
+The main channel for development is the "derby-dev" mailing list, and the
+main channel for user support is the "derby-user" mailing list.
+As is usual with mailing lists, be prepared to wait for an answer.
+</p>
+<p>
+The Derby community also maintains an IRC channel on the freenode IRC
+network. You are welcome to stop by:
+</p>
+<p class="code-block">/server irc.freenode.org
+/join #derby
+</p>
+<p>
+However, keep in mind that all decisions occur on the Derby mail lists
+and not on IRC. Please summarize any off-list knowledge gained and post
+it for the benefit of all. For example, if a user asks a question and
+gets a response, post that exchange to derby-user. If developers work
+out a strategy for solving a problem, post a summary to derby-dev,
+including alternatives that were considered but ultimately dismissed and
+why. If developers figure out how something works, post a summary of the
+finding to derby-dev.
+</p>
+<p>
+In all cases, additional eyes can catch any errors, point out any
+subtleties, and fill in additional information. The more discussions are
+on-list, the more the rest of the community will benefit from the
+understanding that is developed.
+</p>
+</div>
-<strong>Guidelines</strong>
-</p>
+<a name="N1005B"></a><a name="Contribute+Code+or+Documentation"></a>
+<h2 class="boxed">Contribute Code or Documentation</h2>
+<div class="section">
<p>
If you would like to participate directly in Derby development,
here are a few guidelines:
@@ -183,35 +221,37 @@
</li>
-<li>The Derby community
- <a class="external" href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-dev/200409.mbox/%3c413DEA4B.2080706@debrunners.com%3e">voted to follow</a>
- the guidelines established by the
+<li>Derby follows the guidelines established by the
<a href="http://db.apache.org/guidelines.html">Apache DB Project</a>.
</li>
-
+
+</ul>
+<p>
+Additional information for contributors is on the
+<a class="external" href="http://wiki.apache.org/db-derby/">Derby Wiki</a>. Below
+is just a sampling of the topics covered:
+</p>
+<ul>
+
<li>
- Changes to how Derby follows the Apache DB Project guidelines may
- be called for and voted on using the
- <a href="derby_mail.html">derby-dev</a> mail list.
- </li>
-
+<a class="external" href="http://wiki.apache.org/db-derby/ForNewDevelopers">For New
+ Developers</a>: Information to get started with Derby development.
+ </li>
+
<li>
- This page will maintain a list of how the Derby process differs from the
- Apache DB Project process.
- </li>
+
+<a class="external" href="http://wiki.apache.org/db-derby/DerbyContributorChecklist">Derby
+ Contributor Checklist</a>: Tips for developers contributing code to Derby.
+ </li>
+
+<li>
+<a class="external" href="http://wiki.apache.org/db-derby/DerbyCommitProcess">Derby
+ Commit Process</a>: How a change to Derby actually gets committed.</li>
</ul>
<p>
-
-<strong>Use 'svn diff' for patches, not 'cvs diff'</strong>
-
-</p>
-<p>
-The Apache DB Project recommends using
-<a href="http://db.apache.org/source.html">cvs diff</a>
-output for creating patches,
-but Derby uses <span class="codefrag">svn</span>,
-so use '<span class="codefrag">svn diff</span>' instead.
+The remainder of this section includes some miscellaneous tips that don't
+seem to have made it onto the Wiki (yet).
</p>
<p>
@@ -297,8 +337,7 @@
<p>
-Post the patch to the <a href="derby_mail.html">derby-dev</a> mail list
-or attach it to the Jira issue.
+Attach the patch to the Jira issue.
</p>
@@ -390,7 +429,7 @@
<p>
-<em>Last updated: July 31, 2005</em>
+<em>Last updated: March 3, 2006</em>
</p>
Modified: db/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml
URL: http://svn.apache.org/viewcvs/db/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml?rev=382967&r1=382966&r2=382967&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml Fri Mar 3 15:35:47 2006
@@ -26,7 +26,7 @@
Subscribe to the <a href="derby_mail.html">Derby mail lists</a>.
</li>
<li>
- Participate in the <a href="http://wiki.apache.org/db-derby">Derby Wiki</a>.
+ Add your wisdom to the <a href="http://wiki.apache.org/db-derby">Derby Wiki</a>.
</li>
<li>
@@ -52,11 +52,51 @@
</section>
<section>
+<title>Communication Channels</title>
+
+<p>
+The primary mechanism for Derby communication is
+the <a href="derby_mail.html">Derby mail lists</a>.
+Anyone can participate, no matter what their time zone. The ASF
+maintains a reliable searchable archive of past discussions. Oversight
+is enabled. Many eyes ensures that the project evolves in a consistent
+direction.
+The main channel for development is the "derby-dev" mailing list, and the
+main channel for user support is the "derby-user" mailing list.
+As is usual with mailing lists, be prepared to wait for an answer.
+</p>
+<p>
+The Derby community also maintains an IRC channel on the freenode IRC
+network. You are welcome to stop by:
+</p>
+
+<p class="code-block">/server irc.freenode.org
+/join #derby
+</p>
+
+<p>
+However, keep in mind that all decisions occur on the Derby mail lists
+and not on IRC. Please summarize any off-list knowledge gained and post
+it for the benefit of all. For example, if a user asks a question and
+gets a response, post that exchange to derby-user. If developers work
+out a strategy for solving a problem, post a summary to derby-dev,
+including alternatives that were considered but ultimately dismissed and
+why. If developers figure out how something works, post a summary of the
+finding to derby-dev.
+</p>
+
+<p>
+In all cases, additional eyes can catch any errors, point out any
+subtleties, and fill in additional information. The more discussions are
+on-list, the more the rest of the community will benefit from the
+understanding that is developed.
+</p>
+
+</section>
+
+<section>
<title>Contribute Code or Documentation</title>
-<p>
-<strong>Guidelines</strong>
-</p>
<p>
If you would like to participate directly in Derby development,
here are a few guidelines:
@@ -69,32 +109,32 @@
Way</a>.
</li>
- <li>The Derby community
- <a href="http://mail-archives.eu.apache.org/mod_mbox/db-derby-dev/200409.mbox/%3c413DEA4B.2080706@debrunners.com%3e">voted to follow</a>
- the guidelines established by the
+ <li>Derby follows the guidelines established by the
<a href="http://db.apache.org/guidelines.html">Apache DB Project</a>.
</li>
- <li>
- Changes to how Derby follows the Apache DB Project guidelines may
- be called for and voted on using the
- <a href="derby_mail.html">derby-dev</a> mail list.
- </li>
- <li>
- This page will maintain a list of how the Derby process differs from the
- Apache DB Project process.
- </li>
</ul>
-<p>
-<strong>Use 'svn diff' for patches, not 'cvs diff'</strong>
-</p>
+<p>
+Additional information for contributors is on the
+<a href="http://wiki.apache.org/db-derby/">Derby Wiki</a>. Below
+is just a sampling of the topics covered:
+</p>
+
+<ul>
+ <li><a href="http://wiki.apache.org/db-derby/ForNewDevelopers">For New
+ Developers</a>: Information to get started with Derby development.
+ </li>
+ <li>
+ <a href="http://wiki.apache.org/db-derby/DerbyContributorChecklist">Derby
+ Contributor Checklist</a>: Tips for developers contributing code to Derby.
+ </li>
+ <li> <a href="http://wiki.apache.org/db-derby/DerbyCommitProcess">Derby
+ Commit Process</a>: How a change to Derby actually gets committed.</li>
+</ul>
<p>
-The Apache DB Project recommends using
-<a href="http://db.apache.org/source.html">cvs diff</a>
-output for creating patches,
-but Derby uses <code>svn</code>,
-so use '<code>svn diff</code>' instead.
+The remainder of this section includes some miscellaneous tips that don't
+seem to have made it onto the Wiki (yet).
</p>
<p>
@@ -161,8 +201,7 @@
<li>
<p>
-Post the patch to the <a href="derby_mail.html">derby-dev</a> mail list
-or attach it to the Jira issue.
+Attach the patch to the Jira issue.
</p>
<p>
@@ -249,7 +288,7 @@
</section>
<p>
-<em>Last updated: July 31, 2005</em>
+<em>Last updated: March 3, 2006</em>
</p>
</body>