commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Commons Wiki] Update of "CreatingStandardWebPresence" by DennisLundberg
Date Sun, 05 Aug 2007 20:46:06 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Commons Wiki" for change notification.

The following page has been changed by DennisLundberg:
http://wiki.apache.org/commons/CreatingStandardWebPresence

The comment on the change is:
TLP changes

------------------------------------------------------------------------------
- = Jakarta Commons Standard Web Presence =
+ = Commons Standard Web Presence =
  
  == The Problem ==
  
- Currently, each Jakarta Commons component is entirely responsible for its own web site.
In addition, the "home" Commons site is maintained independently of the components themselves.
The following problems result from this arrangement.
+ Currently, each Commons component is entirely responsible for its own web site. In addition,
the "home" Commons site is maintained independently of the components themselves. The following
problems result from this arrangement.
  
   * Different components use different visual styles for their individual sites. This contributes
to an apparent lack of cohesion within the Commons project, both to end users and to others
in the Apache community. It also makes it more difficult for users to navigate through the
Commons site, since there is no unified look and feel.
   * Different components use different technologies for their individual sites. In addition
to increasing the barrier to entry for individuals to contribute to multiple components, this
complicates the process of creating a unified Commons "home" site.
@@ -13, +13 @@

  
  == The Proposal ==
  
- The Jakarta Commons community has deemed it a worthwhile goal to create a common looking
web presence across all of the Jakarta Commons components.  To accomplish this goal, a common
web site generation and deployment process will be developed and employed by all the Jakarta
Commons components.  The final process will meet the following requirements:
+ The Commons community has deemed it a worthwhile goal to create a common looking web presence
across all of the Commons components.  To accomplish this goal, a common web site generation
and deployment process will be developed and employed by all the Commons components.  The
final process will meet the following requirements:
   * The site for each component (proper or sandbox) can be generated and deployed independently
of those for other components.
-  * All component sites include the same global navigation links to important Jakarta Commons,
Jakarta, and Apache assets.
+  * All component sites include the same global navigation links to important Commons and
Apache assets.
-  * Each component provides quick navigation links to the other Jakarta Commons components
on which it depends.
+  * Each component provides quick navigation links to the other Commons components on which
it depends.
-  * The main Jakarta Commons site has the same global navigation links as the components
themselves.
+  * The main Commons site has the same global navigation links as the components themselves.
-  * The main Jakarta Commons site provides quick navigation links to each and every Jakarta
Commons component.
+  * The main Commons site provides quick navigation links to each and every Commons component.
  
  == The Plan ==
  
  === Use of Maven ===
  
- Of all the tools available to generate websites, Maven has been chosen to create the Jakarta
Commons components' sites.  The primary reasons for this choice are:
+ Of all the tools available to generate websites, Maven has been chosen to create the Commons
components' sites.  The primary reasons for this choice are:
-  * It is extremely versitle at creating websites and provides a lot of project content without
much effort.
+  * It is extremely versatile at creating websites and provides a lot of project content
without much effort.
   * It provides the means to work on the components individually or as a group.
   * Many Jakarta Commons components are using Maven already for their build process, include
site generation.
   * Many Jakarta Commons committers and contributors have solid working knowledge of Maven
and have expressed a desire to help with the standarization
  
- === Step 1. Mavenize all Jakarta Commons Components ===
+ === Step 1. Mavenize all Commons Components ===
  
- Some Jakarta Commons components already have a Maven generated site.  Most, however, do
not use Maven for site generation or deployment.  The first step to reaching a common looking
web presence is to mavenize all the components under the Jakarta Commons moniker.
+ Some Commons components already have a Maven generated site.  Most, however, do not use
Maven for site generation or deployment.  The first step to reaching a common looking web
presence is to mavenize all the components under the Commons moniker.
  
  === (PROPOSED) Step 2. Define a Standard "Interface" which every Component site should implement.
===
  Each component should have a series of common pages.  Such as "description", "examples",
"FAQ", "roadmap".  
  
  Each component should use a xdocs/navigation.xml for their menus.
  Make use of the top-menus and bottom-menus xml entities to include the common menus, for
example:
- http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons/dbcp/xdocs/navigation.xml?rev=1.4&content-type=text/plain
+ http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/xdocs/navigation.xml?view=co
  
  Each component should have a xdocs/download.xml file. 
  It should give an overview of all available resources.
@@ -50, +50 @@

   * cvs access
  
  For example:
- http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons/dbcp/xdocs/downloads.xml?content-type=text%2Fplain
+ http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/xdocs/downloads.xml?content-type=text%2Fplain&view=co
  
  Each component should have a project.xml extending project-base.xml
  For example:
- http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons/dbcp/project.xml?content-type=text%2Fplain
+ http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/project.xml?content-type=text%2Fplain&view=co
  
  Each component should have a project.properties file that includes the following:
  maven.xdoc.date=bottom, maven.xdoc.poweredby.image=maven-feather.png
  For example:
- http://cvs.apache.org/viewcvs.cgi/*checkout*/jakarta-commons/dbcp/project.properties
+ http://svn.apache.org/viewvc/commons/proper/dbcp/trunk/project.properties
  
  Each component should have a build.xml file that can be used by gump. Not using the maven
jars but the gump dependencies.
  (only required for proper components?)
  
- === (PROPOSED) Step 3. Reoganize the content of main commons site ===
+ === (PROPOSED) Step 3. Reorganize the content of main commons site ===
  TODO
  
  == How to deploy ==
  
   * Use Maven 1.0.
-  * jakarta-commons/commons-build/ `maven -Dmaven.username=foo site:deploy` updates the main
Commons site.
+  * commons/commons-build/ `maven -Dmaven.username=foo site:deploy` updates the main Commons
site.
   * Checkout commons-build and your component, go to your component directory and run `maven
-Dmaven.username=foo site:deploy` and your component site is updated.
  
  == Current Status ==

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Mime
View raw message