incubator-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rdon...@apache.org
Subject svn commit: r422553 - in /incubator/public/trunk: site-author/guides/sites.xml site-publish/guides/sites.html
Date Sun, 16 Jul 2006 22:07:14 GMT
Author: rdonkin
Date: Sun Jul 16 15:07:14 2006
New Revision: 422553

URL: http://svn.apache.org/viewvc?rev=422553&view=rev
Log:
Added content describing podling website best practices (JIRA INCUBATOR-26) contributed by
Craig Russell. Also some editorial changes to rationalise existing material.

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

Modified: incubator/public/trunk/site-author/guides/sites.xml
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-author/guides/sites.xml?rev=422553&r1=422552&r2=422553&view=diff
==============================================================================
--- incubator/public/trunk/site-author/guides/sites.xml (original)
+++ incubator/public/trunk/site-author/guides/sites.xml Sun Jul 16 15:07:14 2006
@@ -2,52 +2,147 @@
 <document>
   <properties>
     <atom url="http://mail-archives.apache.org/mod_mbox/incubator-general/?format=atom">general@incubator.apache.org
Archives</atom>
-    <title>Updating the Podling's Website</title>
+    <title>Podling Web Site Guide</title>
   </properties>
   <body>
   
-     <section>
-       <title>Purpose of this document</title>
-       <p>Podlings are, by definition, not yet fully accepted as part of the
-       Apache Software Foundation. Therefore, they are subject to additional
-       constraints on their websites.  These policies MUST be adhered to
-       before Graduation is considered unless prior approval is obtained from
-       the Incubator PMC.</p>
-     </section>
     <section>
-      <title>Podling Website Requirements</title>
-      <ul>
-      <li>Every podling site sources stay in the podling SVN</li>
-      <li>Every podling conforms to this URL space for publishing the site:
-      <code>http://incubator.apache.org/podlingname/</code></li>
-      <li>Every podling has an incubation status file under:
-          <code>http://incubator.apache.org/projects/podlingname.html</code>
-          </li>
-       <li>Every podling has eventual extra incubation docs under:
-           <code>http://incubator.apache.org/projects/podlingname/**</code>
+        <title>Abstract</title>
+        <p>
+Podlings need to build a community in Apache in order to be accepted
+as part of the Apache Software Foundation. One of the tools used to build
+a community is the web site.
+        </p>
+    </section>
+     
+    <section>
+        <title>Podling Website Requirements</title>
+        <p>
+Podlings are, by definition, not yet fully accepted as part of the
+Apache Software Foundation. Therefore, they are subject to additional
+constraints on their websites.  These policies MUST be adhered to
+before Graduation is considered unless prior approval is obtained from
+the Incubator PMC.
+        </p>
+        <ul>
+            <li>
+The sources for every podling site sources should be maintained in the podling's SVN
+            </li>
+            <li>
+The published site for each podling should conform to this URL space:
+<code>http://incubator.apache.org/podlingname/</code>
+            </li>
+            <li>
+Every podling should maintain an incubation status file under:
+<code>http://incubator.apache.org/projects/podlingname.html</code>
+            </li>
+            <li>
+Eventual extra incubation documents should be filed under:
+<code>http://incubator.apache.org/projects/podlingname/**</code>
            </li>
-       <li>The website lives in the following directory on people.apache.org:
-           <code>/www/incubator.apache.org/podlingname</code></li>
-       </ul>
+           <li>
+The website lives in the following directory on people.apache.org:
+           <code>/www/incubator.apache.org/podlingname</code>
+           </li>
+        </ul>
      </section>
+       
      <section>
-       <title>Creating the Podling Website</title>
-
-       <p>To create the website, the directory
-       <code>/www/incubator.apache.org/podlingname</code> is checked out
-       of SVN. We don't care how it gets into SVN, or which SVN module
-       it lives in, but it had better be there.  See instructions for
-       your podling website for more information.</p>
-
-       <p>People using Maven, Forrest, or any other tool still have
-       to address the SVN publishing requirement that the
-       infrastructure team has laid out. If that is done, then we
-       just run "svn update" in that directory to load the site from
-       SVN.</p>
-
-       <p>The Mentors MUST add the information to the podling
-       incubation status file, to describe the SVN module and the
-       directory which holds the published site.</p>
+        <title>Creating the Podling Website</title>
+        <section>
+        <title>Creating A Good Podling Site</title>
+            <p>
+  Apache Project Web Sites typically include several standard pages.
+  Each page is formatted with a navigation bar on the left and a project
+  standard header that includes the Incubator graphic.
+            </p>
+            <p>
+  The Web Site can be established during incubation, and migrated
+  after incubation to a permanent place in the TLP home.
+            </p>
+            <ul>
+                <li>
+  Project Home Page: the primary entry point to the site; contains 
+  project description, news, invitation to join the project.
+                </li><li>
+  License Page: usually, the Apache License 2.0
+                </li><li>
+  Downloads: many projects in incubation will release code,
+  and this page describes them and has links to the download pages
+  that redirect to Apache Mirror sites.
+                </li><li>
+  Documentation: this page describes the project documentation,
+  including javadoc for Java projects; guides, tutorials, and links to
+  external documentation.
+                </li><li>
+  Committers: a list of current committers on the project.
+                </li><li>
+  Mailing Lists: there are several mailing lists that the
+  community might be interested in, and this page contains mailto: links
+  that allow easy subscription (and unsubscription) to any of them.
+                </li><li>
+  FAQ: frequently asked questions are answered here.
+                </li><li>
+  Road Map: if the project has a vision of future community
+  or development activities, the road map is published here.
+                </li><li>
+  Source Code: links to the browsable source repository and
+  svn commands to check out the sources.
+                </li><li>
+  Coding Standards: the coding standards for submitted code
+  by the community, along with a description of how strict the project
+  intends to be.
+                </li><li>
+  Issue Tracking: links to the JIRA or other issue tracking
+  tool, possibly including frequently used filters for issue lists.
+                </li><li>
+  Dependencies: other projects that this project depends on.
+                </li></ul>
+        </section>
+  
+    <section id="Tool">
+        <title>Web Site Generation Tool</title>
+            <p>
+  The choice of tool used to generate the web site is left to 
+  the podling. If you already have a tool that you are comfortable
+  with, you can continue to use it. If you do not, consider using
+  <a href='http://jakarta.apache.org/velocity/docs/anakia'>Anakia</a>, 
+  a tool that processes xml to produce html.
+            </p>
+            <p>
+  Regardless of which tool you use, the web site should be maintained
+  in the svn repository, and include the site generation tool as a binary
+  file. This simplifies the process of site generation and enables changes
+  to the site to be made by any committer. The generated site should also
+  be checked into svn. This allows the generated site to be relocated
+  to any part of the Apache site after incubation is complete.
+            </p>
+            <p>
+  Since the site is independent of the code, it should exist high in
+  the svn repository, e.g. parallel to the trunk of the source tree.
+            </p>
+        </section>
+        
+        <section><title>Publishing The Website</title>
+            <p>
+The website is published by checking out the content from SVN into 
+the directory <code>/www/incubator.apache.org/podlingname</code> on 
+<code>people.apache.org</code>. The particular SVN module used to
+store the website is a matter for the podling but it should be in SVN.
+           </p>
+           <p>
+People using Maven, Forrest, or any other tool still have
+to address the SVN publishing requirement that the
+infrastructure team has laid out. If that is done, then we
+just run "svn update" in that directory to load the site from
+SVN.
+           </p>
+           <p>
+The Mentors MUST add the information to the podling
+incubation status file, to describe the SVN module and the
+directory which holds the published site.
+           </p>
+        </section>
     </section>
     
     <section>

Modified: incubator/public/trunk/site-publish/guides/sites.html
URL: http://svn.apache.org/viewvc/incubator/public/trunk/site-publish/guides/sites.html?rev=422553&r1=422552&r2=422553&view=diff
==============================================================================
--- incubator/public/trunk/site-publish/guides/sites.html (original)
+++ incubator/public/trunk/site-publish/guides/sites.html Sun Jul 16 15:07:14 2006
@@ -19,7 +19,7 @@
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="/style/style.css" type="text/css" />
     <link rel="alternate" title="general@incubator.apache.org Archives" type="application/atom+xml"
href="http://mail-archives.apache.org/mod_mbox/incubator-general/?format=atom" />
-    <title>Updating the Podling's Website - Apache Incubator</title>
+    <title>Podling Web Site Guide - Apache Incubator</title>
  </head>
  <body>        
   <table border="0" width="100%" cellspacing="0">
@@ -78,50 +78,151 @@
     <!-- CONTENT -->
     <td align="left" valign="top" class="content">
                 <h2><img src="/images/redarrow.gif" />
-   Purpose of this document
+   Abstract
 </h2>
 <div class="section-content">
-<p>Podlings are, by definition, not yet fully accepted as part of the
-       Apache Software Foundation. Therefore, they are subject to additional
-       constraints on their websites.  These policies MUST be adhered to
-       before Graduation is considered unless prior approval is obtained from
-       the Incubator PMC.</p>
+<p>
+Podlings need to build a community in Apache in order to be accepted
+as part of the Apache Software Foundation. One of the tools used to build
+a community is the web site.
+        </p>
 </div>
            <h2><img src="/images/redarrow.gif" />
    Podling Website Requirements
 </h2>
 <div class="section-content">
+<p>
+Podlings are, by definition, not yet fully accepted as part of the
+Apache Software Foundation. Therefore, they are subject to additional
+constraints on their websites.  These policies MUST be adhered to
+before Graduation is considered unless prior approval is obtained from
+the Incubator PMC.
+        </p>
 <ul>
-      <li>Every podling site sources stay in the podling SVN</li>
-      <li>Every podling conforms to this URL space for publishing the site:
-      <code>http://incubator.apache.org/podlingname/</code></li>
-      <li>Every podling has an incubation status file under:
-          <code>http://incubator.apache.org/projects/podlingname.html</code>
-          </li>
-       <li>Every podling has eventual extra incubation docs under:
-           <code>http://incubator.apache.org/projects/podlingname/**</code>
+            <li>
+The sources for every podling site sources should be maintained in the podling's SVN
+            </li>
+            <li>
+The published site for each podling should conform to this URL space:
+<code>http://incubator.apache.org/podlingname/</code>
+            </li>
+            <li>
+Every podling should maintain an incubation status file under:
+<code>http://incubator.apache.org/projects/podlingname.html</code>
+            </li>
+            <li>
+Eventual extra incubation documents should be filed under:
+<code>http://incubator.apache.org/projects/podlingname/**</code>
            </li>
-       <li>The website lives in the following directory on people.apache.org:
-           <code>/www/incubator.apache.org/podlingname</code></li>
-       </ul>
+           <li>
+The website lives in the following directory on people.apache.org:
+           <code>/www/incubator.apache.org/podlingname</code>
+           </li>
+        </ul>
 </div>
            <h2><img src="/images/redarrow.gif" />
    Creating the Podling Website
 </h2>
 <div class="section-content">
-<p>To create the website, the directory
-       <code>/www/incubator.apache.org/podlingname</code> is checked out
-       of SVN. We don't care how it gets into SVN, or which SVN module
-       it lives in, but it had better be there.  See instructions for
-       your podling website for more information.</p>
-<p>People using Maven, Forrest, or any other tool still have
-       to address the SVN publishing requirement that the
-       infrastructure team has laid out. If that is done, then we
-       just run "svn update" in that directory to load the site from
-       SVN.</p>
-<p>The Mentors MUST add the information to the podling
-       incubation status file, to describe the SVN module and the
-       directory which holds the published site.</p>
+<h3>
+   Creating A Good Podling Site
+</h3>
+<div class="section-content">
+<p>
+  Apache Project Web Sites typically include several standard pages.
+  Each page is formatted with a navigation bar on the left and a project
+  standard header that includes the Incubator graphic.
+            </p>
+<p>
+  The Web Site can be established during incubation, and migrated
+  after incubation to a permanent place in the TLP home.
+            </p>
+<ul>
+                <li>
+  Project Home Page: the primary entry point to the site; contains 
+  project description, news, invitation to join the project.
+                </li><li>
+  License Page: usually, the Apache License 2.0
+                </li><li>
+  Downloads: many projects in incubation will release code,
+  and this page describes them and has links to the download pages
+  that redirect to Apache Mirror sites.
+                </li><li>
+  Documentation: this page describes the project documentation,
+  including javadoc for Java projects; guides, tutorials, and links to
+  external documentation.
+                </li><li>
+  Committers: a list of current committers on the project.
+                </li><li>
+  Mailing Lists: there are several mailing lists that the
+  community might be interested in, and this page contains mailto: links
+  that allow easy subscription (and unsubscription) to any of them.
+                </li><li>
+  FAQ: frequently asked questions are answered here.
+                </li><li>
+  Road Map: if the project has a vision of future community
+  or development activities, the road map is published here.
+                </li><li>
+  Source Code: links to the browsable source repository and
+  svn commands to check out the sources.
+                </li><li>
+  Coding Standards: the coding standards for submitted code
+  by the community, along with a description of how strict the project
+  intends to be.
+                </li><li>
+  Issue Tracking: links to the JIRA or other issue tracking
+  tool, possibly including frequently used filters for issue lists.
+                </li><li>
+  Dependencies: other projects that this project depends on.
+                </li></ul>
+</div>
+<h3>
+   <a name="Tool">Web Site Generation Tool</a>
+</h3>
+<div class="section-content">
+<p>
+  The choice of tool used to generate the web site is left to 
+  the podling. If you already have a tool that you are comfortable
+  with, you can continue to use it. If you do not, consider using
+  <a href="http://jakarta.apache.org/velocity/docs/anakia">Anakia</a>, 
+  a tool that processes xml to produce html.
+            </p>
+<p>
+  Regardless of which tool you use, the web site should be maintained
+  in the svn repository, and include the site generation tool as a binary
+  file. This simplifies the process of site generation and enables changes
+  to the site to be made by any committer. The generated site should also
+  be checked into svn. This allows the generated site to be relocated
+  to any part of the Apache site after incubation is complete.
+            </p>
+<p>
+  Since the site is independent of the code, it should exist high in
+  the svn repository, e.g. parallel to the trunk of the source tree.
+            </p>
+</div>
+<h3>
+   Publishing The Website
+</h3>
+<div class="section-content">
+<p>
+The website is published by checking out the content from SVN into 
+the directory <code>/www/incubator.apache.org/podlingname</code> on 
+<code>people.apache.org</code>. The particular SVN module used to
+store the website is a matter for the podling but it should be in SVN.
+           </p>
+<p>
+People using Maven, Forrest, or any other tool still have
+to address the SVN publishing requirement that the
+infrastructure team has laid out. If that is done, then we
+just run "svn update" in that directory to load the site from
+SVN.
+           </p>
+<p>
+The Mentors MUST add the information to the podling
+incubation status file, to describe the SVN module and the
+directory which holds the published site.
+           </p>
+</div>
 </div>
            <h2><img src="/images/redarrow.gif" />
    Main Incubator Website



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


Mime
View raw message