forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r390291 [2/2] - in /forrest/site: ./ docs_0_60/ docs_0_70/ docs_0_70/howto/ docs_0_80/
Date Fri, 31 Mar 2006 00:41:05 GMT
Modified: forrest/site/forrest-issues.html
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.html?rev=390291&r1=390290&r2=390291&view=diff
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Thu Mar 30 16:41:03 2006
@@ -189,16 +189,16 @@
 <div id="minitoc-area">
 <ul class="minitoc">
 <li>
-<a href="#%5BFOR-591%5D+MaxMemory+needs+increasing">[FOR-591] MaxMemory needs increasing</a>
+<a href="#%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core">[FOR-796]
Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher and org.apache.forrest.themes.core</a>
 </li>
 <li>
 <a href="#%5BFOR-713%5D+HTML-to-document.xsl+no+longer+generates+an+XDoc">[FOR-713]
HTML-to-document.xsl no longer generates an XDoc</a>
 </li>
 <li>
-<a href="#%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links">[FOR-762]
Default page URL for breadcrumbs and site: links</a>
+<a href="#%5BFOR-591%5D+MaxMemory+needs+increasing">[FOR-591] MaxMemory needs increasing</a>
 </li>
 <li>
-<a href="#%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core">[FOR-796]
Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher and org.apache.forrest.themes.core</a>
+<a href="#%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links">[FOR-762]
Default page URL for breadcrumbs and site: links</a>
 </li>
 <li>
 <a href="#%5BFOR-388%5D+Use+plugins+in-place+if+src+available">[FOR-388] Use plugins
in-place if src available</a>
@@ -210,15 +210,15 @@
 <a href="#%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode">[FOR-735]
Plugins are not correctly deployed in webapp mode</a>
 </li>
 <li>
-<a href="#%5BFOR-707%5D+Document+i18n+features+of+Forrest">[FOR-707] Document i18n
features of Forrest</a>
-</li>
-<li>
 <a href="#%5BFOR-711%5D+Cache+results+from+the+Locationmap">[FOR-711] Cache results
from the Locationmap</a>
 </li>
 <li>
 <a href="#%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo">[FOR-742]
trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo</a>
 </li>
 <li>
+<a href="#%5BFOR-707%5D+Document+i18n+features+of+Forrest">[FOR-707] Document i18n
features of Forrest</a>
+</li>
+<li>
 <a href="#%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes">[FOR-241]
character entities (e.g. ampersand) are expanded again for href or src attributes</a>
 </li>
 <li>
@@ -273,25 +273,13 @@
        <a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?pid=12310000&resolutionIds=-1&tempMax=1000&reset=true">all</a>
open issues).
       The listing below is regenerated on each Forrest run.</div>
 </div>
-<a name="N10011"></a><a name="%5BFOR-591%5D+MaxMemory+needs+increasing"></a>
-<h2 class="underlined_10">[FOR-591] MaxMemory needs increasing</h2>
+<a name="N10011"></a><a name="%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core"></a>
+<h2 class="underlined_10">[FOR-796] Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher
and org.apache.forrest.themes.core</h2>
 <div class="section">
 <p>
-<a href="http://issues.apache.org/jira/browse/FOR-591">http://issues.apache.org/jira/browse/FOR-591</a>
+<a href="http://issues.apache.org/jira/browse/FOR-796">http://issues.apache.org/jira/browse/FOR-796</a>
 </p>
-<p>Since the docs restructurng for the 0.7 release it has become necessary to increase
the maxmemory to be able to build the Forrest site.
-&lt;br&gt;
-
-&lt;br&gt;
-Does this indicate a memory leak?
-&lt;br&gt;
-
-&lt;br&gt;
-Does someone have the tools to run some diagnostics?
-&lt;br&gt;
-
-&lt;br&gt;
-(NB maxmemory has been increased in forrest.properties, if we resolve this issue it should
be reduced again)</p>
+<p>This is the global issue to keep track on the merging effort</p>
 </div>
 <a name="N1001D"></a><a name="%5BFOR-713%5D+HTML-to-document.xsl+no+longer+generates+an+XDoc"></a>
 <h2 class="underlined_10">[FOR-713] HTML-to-document.xsl no longer generates an XDoc</h2>
@@ -309,7 +297,27 @@
 &lt;br&gt;
 </p>
 </div>
-<a name="N10029"></a><a name="%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links"></a>
+<a name="N10029"></a><a name="%5BFOR-591%5D+MaxMemory+needs+increasing"></a>
+<h2 class="underlined_10">[FOR-591] MaxMemory needs increasing</h2>
+<div class="section">
+<p>
+<a href="http://issues.apache.org/jira/browse/FOR-591">http://issues.apache.org/jira/browse/FOR-591</a>
+</p>
+<p>Since the docs restructurng for the 0.7 release it has become necessary to increase
the maxmemory to be able to build the Forrest site.
+&lt;br&gt;
+
+&lt;br&gt;
+Does this indicate a memory leak?
+&lt;br&gt;
+
+&lt;br&gt;
+Does someone have the tools to run some diagnostics?
+&lt;br&gt;
+
+&lt;br&gt;
+(NB maxmemory has been increased in forrest.properties, if we resolve this issue it should
be reduced again)</p>
+</div>
+<a name="N10035"></a><a name="%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links"></a>
 <h2 class="underlined_10">[FOR-762] Default page URL for breadcrumbs and site: links</h2>
 <div class="section">
 <p>
@@ -341,14 +349,6 @@
 &lt;br&gt;
 Cocoon does not appear to assume the end node directory is index.* and thus appends no file
automatically as tomcat or the http server does so it must be manually done. </p>
 </div>
-<a name="N10035"></a><a name="%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core"></a>
-<h2 class="underlined_10">[FOR-796] Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher
and org.apache.forrest.themes.core</h2>
-<div class="section">
-<p>
-<a href="http://issues.apache.org/jira/browse/FOR-796">http://issues.apache.org/jira/browse/FOR-796</a>
-</p>
-<p>This is the global issue to keep track on the merging effort</p>
-</div>
 <a name="N10041"></a><a name="%5BFOR-388%5D+Use+plugins+in-place+if+src+available"></a>
 <h2 class="underlined_10">[FOR-388] Use plugins in-place if src available</h2>
 <div class="section">
@@ -397,27 +397,7 @@
 &lt;br&gt;
 - the pdf links give an error &amp;quot;Resource Not Found&amp;quot;</p>
 </div>
-<a name="N10065"></a><a name="%5BFOR-707%5D+Document+i18n+features+of+Forrest"></a>
-<h2 class="underlined_10">[FOR-707] Document i18n features of Forrest</h2>
-<div class="section">
-<p>
-<a href="http://issues.apache.org/jira/browse/FOR-707">http://issues.apache.org/jira/browse/FOR-707</a>
-</p>
-<p>There is next to no documentation about i18n, just a pretty poor FAQ entry that
points at an issue that has now been closed.
-&lt;br&gt;
-
-&lt;br&gt;
-Cheche wrote a blog entry on his work:
-&lt;br&gt;
-
-&lt;br&gt;
-&lt;a href="http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/"&gt;http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/&lt;/a&gt;
-&lt;br&gt;
-
-&lt;br&gt;
-We could, at the very least use the locationmap to pull this content into our site [OT: I
wonder if this could be a way to generate more documentation?)</p>
-</div>
-<a name="N10071"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
+<a name="N10065"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
 <h2 class="underlined_10">[FOR-711] Cache results from the Locationmap</h2>
 <div class="section">
 <p>
@@ -433,7 +413,7 @@
 &lt;br&gt;
 If we test all locationmaps and find no result we should record that tere is no result in
this hashmap. This will also be a good place to throw an exception so that Cocoon can better
report such errors (see FOR-701)</p>
 </div>
-<a name="N1007D"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
+<a name="N10071"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
 <h2 class="underlined_10">[FOR-742] trouble accessing unversioned plugin for a released
version of Forrest, e.g. projectInfo</h2>
 <div class="section">
 <p>
@@ -446,6 +426,26 @@
 The solution is discussed here:
 &lt;br&gt;
 &lt;a href="http://marc.theaimsgroup.com/?t=113176328300002"&gt;http://marc.theaimsgroup.com/?t=113176328300002&lt;/a&gt;</p>
+</div>
+<a name="N1007D"></a><a name="%5BFOR-707%5D+Document+i18n+features+of+Forrest"></a>
+<h2 class="underlined_10">[FOR-707] Document i18n features of Forrest</h2>
+<div class="section">
+<p>
+<a href="http://issues.apache.org/jira/browse/FOR-707">http://issues.apache.org/jira/browse/FOR-707</a>
+</p>
+<p>There is next to no documentation about i18n, just a pretty poor FAQ entry that
points at an issue that has now been closed.
+&lt;br&gt;
+
+&lt;br&gt;
+Cheche wrote a blog entry on his work:
+&lt;br&gt;
+
+&lt;br&gt;
+&lt;a href="http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/"&gt;http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/&lt;/a&gt;
+&lt;br&gt;
+
+&lt;br&gt;
+We could, at the very least use the locationmap to pull this content into our site [OT: I
wonder if this could be a way to generate more documentation?)</p>
 </div>
 <a name="N10089"></a><a name="%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes"></a>
 <h2 class="underlined_10">[FOR-241] character entities (e.g. ampersand) are expanded
again for href or src attributes</h2>

Modified: forrest/site/forrest-issues.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.pdf?rev=390291&r1=390290&r2=390291&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/guidelines.html
URL: http://svn.apache.org/viewcvs/forrest/site/guidelines.html?rev=390291&r1=390290&r2=390291&view=diff
==============================================================================
--- forrest/site/guidelines.html (original)
+++ forrest/site/guidelines.html Thu Mar 30 16:41:03 2006
@@ -192,7 +192,7 @@
 <a href="#mission">The mission of Apache Forrest</a>
 </li>
 <li>
-<a href="#way">The Apache Way</a>
+<a href="#way">Open development</a>
 </li>
 <li>
 <a href="#roles">Roles and responsibilities</a>
@@ -241,6 +241,9 @@
 <a href="#code">Code management</a>
 </li>
 <li>
+<a href="#contribution">Contribution and acknowledgement</a>
+</li>
+<li>
 <a href="#develop">Development procedure</a>
 </li>
 </ul>
@@ -251,7 +254,7 @@
    This document provides the guidelines under which the Apache Forrest
    project operates. It defines the roles and responsibilities, who may vote,
    how voting works, how conflicts are resolved, etc.
-   Apache Forrest is a project of the Apache Software Foundation
+   Apache Forrest is a project of The Apache Software Foundation
    (<a href="http://www.apache.org/foundation/">ASF</a>) which is a
    non-profit corporation. As with all such organisations there are some
    procedures to be followed.
@@ -274,16 +277,18 @@
 
   
 <a name="N1001E"></a><a name="way"></a>
-<h2 class="underlined_10">The Apache Way</h2>
+<h2 class="underlined_10">Open development</h2>
 <div class="section">
 <p>
       Forrest is typical of Apache projects, in that it operates under a set of
-      principles known collectively as the "Apache Way". There is no clear definition 
+      principles that encourage open development. There is no clear definition 
       (perhaps that is part of it) and it is ever-evolving. Each ASF project is different
       in its own way - there is healthy diversity rather than uniformity across all projects.
       The main principles are to facilitate open collaborative development, with respect
for
       others; to ensure that there is a healthy community (even to give community issues
-      higher priority than code issues); to ensure that each contributor is recognised and
+      higher priority than code issues); to use a consensus-based approach;
+      to ensure that each
+      <a href="#contribution">contributor</a> is recognised and
       feels a productive part of the community; to encourage diversity; to make the project
a nice place to be.
     </p>
 <p>
@@ -314,7 +319,7 @@
 </div>
 
   
-<a name="N10052"></a><a name="roles"></a>
+<a name="N10056"></a><a name="roles"></a>
 <h2 class="underlined_10">Roles and responsibilities</h2>
 <div class="section">
 <p>The meritocracy enables various roles as defined in the
@@ -335,7 +340,7 @@
 </div>
 
   
-<a name="N1007E"></a><a name="pmc"></a>
+<a name="N10082"></a><a name="pmc"></a>
 <h2 class="underlined_10">Project Management Committee (PMC)</h2>
 <div class="section">
 <p>The Apache Forrest project was established in January 2002 and became a
@@ -413,7 +418,7 @@
       <a href="http://www.apache.org/dev/pmc.html#chair">PMC FAQ</a>
     
 </p>
-<a name="N100CB"></a><a name="report"></a>
+<a name="N100CF"></a><a name="report"></a>
 <h3 class="underlined_5">Quarterly reports to ASF Board</h3>
 <p>
         Every three months, it is the responsibility of our PMC chair to
@@ -426,7 +431,7 @@
         <a href="http://www.apache.org/foundation/board/calendar.html">
         board meeting</a>. Our reporting schedule is: Feb, May, Aug, Nov.
       </p>
-<a name="N100DC"></a><a name="elect"></a>
+<a name="N100E0"></a><a name="elect"></a>
 <h3 class="underlined_5">Electing new committers and PMC members</h3>
 <p>
         We conduct the vote on the private PMC mailing list to enable a frank
@@ -442,7 +447,7 @@
 </div>
 
   
-<a name="N100E7"></a><a name="decision"></a>
+<a name="N100EB"></a><a name="decision"></a>
 <h2 class="underlined_10">Decision making</h2>
 <div class="section">
 <p>
@@ -456,7 +461,7 @@
       Most day-to-day operations do not require explicit voting - just get on
       and do the work. See the "Lazy approval" type described below.
     </p>
-<a name="N100F3"></a><a name="voting"></a>
+<a name="N100F7"></a><a name="voting"></a>
 <h3 class="underlined_5">Voting</h3>
 <p>
         Certain actions and decisions regarding the project are made by votes
@@ -545,7 +550,7 @@
         typically take the form of a veto (-1) in reply to the commit message
         sent when the commit is made.
       </p>
-<a name="N10157"></a><a name="approvals"></a>
+<a name="N1015B"></a><a name="approvals"></a>
 <h3 class="underlined_5">Types of approval</h3>
 <p>
         Different actions require different types of approval:
@@ -611,7 +616,7 @@
 </tr>
       
 </table>
-<a name="N101AA"></a><a name="veto"></a>
+<a name="N101AE"></a><a name="veto"></a>
 <h3 class="underlined_5">Vetoes</h3>
 <p>
         A valid veto cannot be over-ruled, it can only be withdrawn by its issuer.
@@ -633,7 +638,7 @@
         If a veto is not withdrawn, the action that has been vetoed must
         be reversed in a timely manner.
       </p>
-<a name="N101BD"></a><a name="actions"></a>
+<a name="N101C1"></a><a name="actions"></a>
 <h3 class="underlined_5">Actions</h3>
 <p>
         This section describes the various actions which are undertaken within
@@ -797,7 +802,7 @@
 </tr>
       
 </table>
-<a name="N102B9"></a><a name="timeframe"></a>
+<a name="N102BD"></a><a name="timeframe"></a>
 <h3 class="underlined_5">Voting timeframes</h3>
 <p>
         Votes are normally open for a period of one week to allow all active voters
@@ -807,7 +812,7 @@
         Votes relating to code changes are not subject to a strict timetable,
         but should be made as timely as possible.
       </p>
-<a name="N102C3"></a><a name="procedure"></a>
+<a name="N102C7"></a><a name="procedure"></a>
 <h3 class="underlined_5">Voting procedure</h3>
 <p>
         Discussion about the topic would have already happened in a [Proposal]
@@ -826,7 +831,7 @@
         At the end of the vote period, the instigator tallies the number of
         final votes and reports the results.
       </p>
-<a name="N102D7"></a><a name="ultimatum"></a>
+<a name="N102DB"></a><a name="ultimatum"></a>
 <h3 class="underlined_5">Ultimatum and breakdown</h3>
 <p>
         For breakdown situations and those requiring unanimous consensus,
@@ -837,7 +842,7 @@
 </div>
 
   
-<a name="N102E2"></a><a name="communication"></a>
+<a name="N102E6"></a><a name="communication"></a>
 <h2 class="underlined_10">Communication channels</h2>
 <div class="section">
 <p>
@@ -871,7 +876,7 @@
 </div>
 
   
-<a name="N102F8"></a><a name="code"></a>
+<a name="N102FC"></a><a name="code"></a>
 <h2 class="underlined_10">Code management</h2>
 <div class="section">
 <p>
@@ -922,7 +927,100 @@
 </div>
 
   
-<a name="N1031D"></a><a name="develop"></a>
+<a name="N10321"></a><a name="contribution"></a>
+<h2 class="underlined_10">Contribution and acknowledgement</h2>
+<div class="section">
+<p>
+      Some <a href="#way">principles</a> of open development at ASF are to ensure
that each
+      contributor is recognised and feels a productive part of the community, and to
+      encourage diversity, respect, and equality.
+      Key to this is the recognition of contributions from individuals
+      in a manner that also recognises the community effort that made it all
+      possible. It is important to remember that there is no concept of
+      individual leadership. See the discussion of
+      <a href="http://www.apache.org/foundation/how-it-works.html#meritocracy">meritocracy</a>
+      and other sections of the
+      <a href="http://www.apache.org/foundation/how-it-works.html">How the ASF works</a>
document.
+    </p>
+<p>
+       In an Open Source Project, or more importantly, a project developed
+       using an open process, such as Apache Forrest, most contributions of actual
+       code are supported by, or at least *should* be supported by, design
+       discussion, oversight, testing, documentation, bug fixes and much more.
+       No code contribution is an independent unit of work (or should not be).
+       It is therefore impossible to credit individual contributors, it is
+       simply unmanageable, even if it is possible to identify each part of a
+       contribution.
+    </p>
+<p>
+      At Apache Forrest we use the following method to provide recognition:
+    </p>
+<ul>
+      
+<li>
+        All developers encourage other developers to participate on the
+        mailing lists, treat each other with respect, and openly collaborate.
+        This enables the contributors to feel a part of the project and shows
+        that their discussion and ideas are valuable. These replies enhance
+        the presence of their name in the email archives and search engines.
+      </li>
+      
+<li>
+        Encourage contributors to add patches via the
+        <a href="issues.html">issue tracker</a>. This also enables clear
+        tracking of the issue and by default specifically shows who was the
+        contributor.
+      </li>
+      
+<li>
+        When committers apply the patch, they refer to the issue number
+        and the contributor's name. This enables linkage between the issue
+        tracker and the Subversion history. It adds the contributor's name
+        to the mail archives.
+      </li>
+      
+<li>
+        Committers apply patches as soon as possible. This keeps the contributor
+        enthused and shows them that their work is valuable.
+      </li>
+      
+<li>
+        Committers add an entry for each significant contribution to the
+        top-level <a href="docs_0_80/changes.html">changes</a> document (site-author/status.xml)
+        and detailed entries to the relevant plugin's changes document. This enables linkage
+        to the relevant issue and shows the contributor's name. It also shows
+        the initials of the committer who did the work to add the patch.
+      </li>
+      
+<li>
+        When committers are adding their own work, they similarly add entries
+        to the "changes" documents. Their initials are added to the entry.
+      </li>
+      
+<li>
+        The existing PMC will notice new contributors who are committed. It eventually
+        <a href="#elect">invites</a> them to become new committers/PMC members.
See the 
+        <a href="committed.html">notes</a> about this topic.
+      </li>
+      
+<li>
+        Committers/PMC members are
+        <a href="who.html">listed</a>.
+      </li>
+    
+</ul>
+<p>
+      As discussed above, there is no specific documentation which lists each
+      contributor and their work. For those who are interested there are various
+      mechanisms: Use general internet search services; use search services provided
+      by various third-party mail archives; search the "svn" mailing list using
+      committer IDs and using contributor names; browse the
+      <a href="docs_0_80/changes.html">changes</a> page; use 'svn log' and 'svn
blame'.
+    </p>
+</div>
+
+  
+<a name="N10373"></a><a name="develop"></a>
 <h2 class="underlined_10">Development procedure</h2>
 <div class="section">
 <div class="note">

Modified: forrest/site/guidelines.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/guidelines.pdf?rev=390291&r1=390290&r2=390291&view=diff
==============================================================================
Binary files - no diff available.



Mime
View raw message