incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r609312 - in /incubator/public/trunk: site-author/guides/index.xml site-publish/guides/index.html
Date Sun, 06 Jan 2008 14:08:57 GMT
Author: rdonkin
Date: Sun Jan  6 06:08:56 2008
New Revision: 609312

URL: http://svn.apache.org/viewvc?rev=609312&view=rev
Log:
Additional material explaining that guides are not normative. Changes derived from posting
by Roland Weber on the general list.

Modified:
    incubator/public/trunk/site-author/guides/index.xml
    incubator/public/trunk/site-publish/guides/index.html

Modified: incubator/public/trunk/site-author/guides/index.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/index.xml?rev=609312&r1=609311&r2=609312&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/index.xml (original)
+++ incubator/public/trunk/site-author/guides/index.xml Sun Jan  6 06:08:56 2008
@@ -19,41 +19,21 @@
   </properties>
   <body>
     <section id='incubation-guides'><title>Incubation Guides</title>
-        <p>
-Contained are longer, more discursive and descriptive guides. 
-These guides are not normative. Policy is defined <a href='/incubation/Incubation_Policy.html'>here</a>.
+      <p>
+    The Incubation Guides linked below are descriptive and at times
+discursive documents. They describe established practices. 
+These guides are informational. They are something to start from 
+and improve on. 
+      </p><p>
+Unlike the <a href="/incubation/Incubation_Policy.html">Policy</a>,
+the guides are <strong>not</strong> normative. You <code>MAY</code>
diverge 
+from a guide whenever it makes sense for your project. Only the
+<a href="/incubation/Incubation_Policy.html">Policy</a>
+is normative and <code>MUST</code> be followed by all projects.
 		</p>
-		<section id='notes'><title>Notes</title>
-			<p>
-Documentation is considered a secondary source. It records experiences and codifying consensus

-formed on the mailing lists and in particular on <code>general.AT.incubator.apache.org</code>.

-Please feel free to <a href='lists.html#general+at+incubator.apache.org'>subscribe</a>
-to this list and ask any questions not covered adequately by the documentation.
-		    </p>
-		    <p>
-The incubator document is intended to be read as a superset of the documentation
-for full Apache projects. See
-			</p>
-			<ul>
-				<li>the Apache Software Foundation <a href="http://www.apache.org/foundation/">documentation
-</a> especially
-					<ul>
-						<li>
-        <a href="http://www.apache.org/foundation/how-it-works.html">Apache: How it
works
-</a>
-						</li>
-					</ul>
-				</li>
-				<li>the Apache
-        <a href="http://www.apache.org/dev/">development documentation
-</a> which includes information for contributors, committers and PMCs
-				</li>
-				<li>the Apache
-        <a href="http://www.apache.org/legal/">legal group documentation
-</a>
-				</li>
-			</ul>
-		  </section>
+        <p>
+        For more information, see these <a href='#notes'>notes</a>.
+        </p>
 		<section id='entry_guides'><title>Entry Guides</title>
 			<ul>
 		      <li><a href="/guides/proposal.html">Proposal Guide</a></li>
@@ -80,6 +60,44 @@
             <li><a href="/guides/website.html">Incubator Website</a></li>
         </ul>
     </section>
+        <section id='notes'><title>Notes</title>
+        <ul>
+        <li>
+Within all Incubator documentation, the terms <code>MAY</code>, <code>MUST</code>

+and <code>SHOULD</code> are used as defined 
+by <a href='http://tools.ietf.org/html/rfc2119'>RFC2119</a>.
+        </li>
+      <li>
+Documentation is considered a secondary source. It records experiences and codifying consensus

+formed on the mailing lists and in particular on <code>general.AT.incubator.apache.org</code>.

+Please feel free to <a href='lists.html#general+at+incubator.apache.org'>subscribe</a>
+to this list and ask any questions not covered adequately by the documentation.
+        </li>
+        <li>
+The incubator document is intended to be read as a superset of the documentation
+for full Apache projects. See
+      <ul>
+        <li>the Apache Software Foundation <a href="http://www.apache.org/foundation/">documentation
+</a> especially
+          <ul>
+            <li>
+        <a href="http://www.apache.org/foundation/how-it-works.html">Apache: How it
works
+</a>
+            </li>
+          </ul>
+        </li>
+        <li>the Apache
+        <a href="http://www.apache.org/dev/">development documentation
+</a> which includes information for contributors, committers and PMCs
+        </li>
+        <li>the Apache
+        <a href="http://www.apache.org/legal/">legal group documentation
+</a>
+        </li>
+      </ul>
+      </li>
+      </ul>
+      </section>
 </section>
   </body>
 </document>

Modified: incubator/public/trunk/site-publish/guides/index.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/index.html?rev=609312&r1=609311&r2=609312&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/index.html (original)
+++ incubator/public/trunk/site-publish/guides/index.html Sun Jan  6 06:08:56 2008
@@ -105,43 +105,21 @@
 </h2>
 <div class="section-content">
 <p>
-Contained are longer, more discursive and descriptive guides. 
-These guides are not normative. Policy is defined <a href="/incubation/Incubation_Policy.html">here</a>.
-		</p>
-<h3>
-   <a name="notes">Notes</a>
-</h3>
-<div class="section-content">
+    The Incubation Guides linked below are descriptive and at times
+discursive documents. They describe established practices. 
+These guides are informational. They are something to start from 
+and improve on. 
+      </p>
 <p>
-Documentation is considered a secondary source. It records experiences and codifying consensus

-formed on the mailing lists and in particular on <code>general.AT.incubator.apache.org</code>.

-Please feel free to <a href="lists.html#general+at+incubator.apache.org">subscribe</a>
-to this list and ask any questions not covered adequately by the documentation.
-		    </p>
+Unlike the <a href="/incubation/Incubation_Policy.html">Policy</a>,
+the guides are <strong>not</strong> normative. You <code>MAY</code>
diverge 
+from a guide whenever it makes sense for your project. Only the
+<a href="/incubation/Incubation_Policy.html">Policy</a>
+is normative and <code>MUST</code> be followed by all projects.
+		</p>
 <p>
-The incubator document is intended to be read as a superset of the documentation
-for full Apache projects. See
-			</p>
-<ul>
-				<li>the Apache Software Foundation <a href="http://www.apache.org/foundation/">documentation
-</a> especially
-					<ul>
-						<li>
-        <a href="http://www.apache.org/foundation/how-it-works.html">Apache: How it
works
-</a>
-						</li>
-					</ul>
-				</li>
-				<li>the Apache
-        <a href="http://www.apache.org/dev/">development documentation
-</a> which includes information for contributors, committers and PMCs
-				</li>
-				<li>the Apache
-        <a href="http://www.apache.org/legal/">legal group documentation
-</a>
-				</li>
-			</ul>
-</div>
+        For more information, see these <a href="#notes">notes</a>.
+        </p>
 <h3>
    <a name="entry_guides">Entry Guides</a>
 </h3>
@@ -175,6 +153,47 @@
             <li><a href="/guides/lists.html">Mailing Lists</a></li>
             <li><a href="/guides/website.html">Incubator Website</a></li>
         </ul>
+</div>
+<h3>
+   <a name="notes">Notes</a>
+</h3>
+<div class="section-content">
+<ul>
+        <li>
+Within all Incubator documentation, the terms <code>MAY</code>, <code>MUST</code>

+and <code>SHOULD</code> are used as defined 
+by <a href="http://tools.ietf.org/html/rfc2119">RFC2119</a>.
+        </li>
+      <li>
+Documentation is considered a secondary source. It records experiences and codifying consensus

+formed on the mailing lists and in particular on <code>general.AT.incubator.apache.org</code>.

+Please feel free to <a href="lists.html#general+at+incubator.apache.org">subscribe</a>
+to this list and ask any questions not covered adequately by the documentation.
+        </li>
+        <li>
+The incubator document is intended to be read as a superset of the documentation
+for full Apache projects. See
+      <ul>
+        <li>the Apache Software Foundation <a href="http://www.apache.org/foundation/">documentation
+</a> especially
+          <ul>
+            <li>
+        <a href="http://www.apache.org/foundation/how-it-works.html">Apache: How it
works
+</a>
+            </li>
+          </ul>
+        </li>
+        <li>the Apache
+        <a href="http://www.apache.org/dev/">development documentation
+</a> which includes information for contributors, committers and PMCs
+        </li>
+        <li>the Apache
+        <a href="http://www.apache.org/legal/">legal group documentation
+</a>
+        </li>
+      </ul>
+      </li>
+      </ul>
 </div>
 </div>
          </td>



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


Mime
View raw message