You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by hu...@apache.org on 2005/09/06 10:55:45 UTC
svn commit: r278945 - in /struts/site/trunk/xdocs: helping.xml mail.xml
navigation.xml using.xml volunteers.xml
Author: husted
Date: Tue Sep 6 01:55:42 2005
New Revision: 278945
URL: http://svn.apache.org/viewcvs?rev=278945&view=rev
Log:
* Merge "using" into "helping".
* Tell my Struts story too.
Removed:
struts/site/trunk/xdocs/using.xml
Modified:
struts/site/trunk/xdocs/helping.xml
struts/site/trunk/xdocs/mail.xml
struts/site/trunk/xdocs/navigation.xml
struts/site/trunk/xdocs/volunteers.xml
Modified: struts/site/trunk/xdocs/helping.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/helping.xml?rev=278945&r1=278944&r2=278945&view=diff
==============================================================================
--- struts/site/trunk/xdocs/helping.xml (original)
+++ struts/site/trunk/xdocs/helping.xml Tue Sep 6 01:55:42 2005
@@ -23,6 +23,12 @@
</p>
<ul>
+ <li><a href="#involved">
+ How can I get involved with Apache Struts?
+ </a></li>
+ <li><a href="#bugs">
+ How do I join the mailing lists?
+ </a></li>
<li><a href="#corp">
What can my company do to help support Struts?
</a></li>
@@ -45,9 +51,101 @@
</subsection>
+<a name="involved"/>
+<subsection name="Getting Involved">
+
+ <p>
+ Every volunteer project obtains its strength
+ from the people involved in it.
+ We invite you to participate as much or as little as you choose.
+ The roles and responsibilities that people can assume in the project
+ are based on merit.
+ Everybody's input matters!
+ </p>
+
+ <p>
+ Here is one developer's advice how to get involved.
+ It specifically talks about Tomcat,
+ but the general idea can applied to any of the Apache Projects.
+ </p>
+
+ <ul>
+ <li>
+ <a href="http://jakarta.apache.org/site/contributing.html">
+ Contributing</a> -- Craig R. McClanahan
+ </li>
+ </ul>
+
+ <p>
+ Here is another comment that was sent to the Jakarta Turbine Mailing
+ List about the open source process and the contrast between how an
+ opensource product and a proprietary product improve through the user
+ community.
+ </p>
+
+ <ul>
+ <li>
+ <a href="http://jakarta.apache.org/site/understandingopensource.html">
+ Understanding Opensource</a> -- Cameron Riley
+ </li>
+ </ul>
+
+ <p>
+ While written for ASF developers,
+ the Rules for Revolutionaries provides insight into how the
+ collaborative process works,
+ and how our process differs from working on a hierarchical team.
+ </p>
+
+ <ul>
+ <li>
+ <a href="http://incubator.apache.org/learn/rules-for-revolutionaries.html">
+ Rules for Revolutionaries</a> -- James Duncan Davidson
+ </li>
+ </ul>
+
+ <p>
+ Just using the products is a very important role.
+ We need people who will report bugs, contribute patches, suggest
+ features, and so forth.
+ Your feedback allows the technology to evolve.
+ </p>
+
+</subsection>
+
+<a name="mail"/>
+<subsection name="Joining the Mailing Lists">
+
+ <p>
+ There are a variety of ways to participate.
+ Regardless of how you choose to participate,
+ we suggest you join our mailing lists.
+ </p>
+
+ <p>
+ Before joining any Apache mailing list, please be sure to read the
+ <a href="mail.html#Guidelines">Mailing List Guidelines</a>.
+ If you have read and understood these guidelines, you are welcome to
+ <a href="mail.html#Subscribing">join the Struts mailing lists</a>.
+ </p>
+
+ <p>
+ Before posting a new question, be sure to consult one of the
+ <a href="mail.html#Archives">
+ <strong>Mailing List Archives</strong></a> and the very excellent
+ <a href="http://www.catb.org/~esr/faqs/smart-questions.html">
+ How To Ask Questions The Smart Way</a> by Eric Raymond.
+ </p>
+
+ <p>
+ Please do be sure to <a href="http://expita.com/nomime.html">turn off
+ HTML</a> in your email client before posting.
+ </p>
+</subsection>
+
+
<a name="corp"/>
<subsection name="What can my company do to help support Struts?">
-
<p>
Struts is an all volunteer product.
Our customers are the volunteers who donate their time and energy to
@@ -113,9 +211,24 @@
</subsection>
<a name="bugs"/>
-<subsection name="How can I report bugs or make feature requests?">
+<subsection name="How can I report bugs or suggest features?">
-<p>
+ <p>
+ Tracking of bug reports and enhancement suggestions for Apache Struts
+ subprojects is handled
+ through the <a href="http://issues.apache.org/bugzilla"> Apache Bug
+ Database</a>.
+ Please select <strong>Struts</strong> from the product list, along with
+ the details of which component of Struts you feel this report
+ relates to, and details of your operating environment.
+ You will automatically be notified by email as the status of your bug or
+ enhancement report changes.
+ Please be sure to read
+ <a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">How to
+ Report Bugs Effectively</a> before posting.
+ </p>
+
+ <p>
You can research and report outstanding fixes and feature requests using
<a href="http://issues.apache.org/bugzilla">Bugzilla</a>.
If you are unsure if this is an actual problem, feel free to bring it up the
@@ -127,7 +240,7 @@
</p>
<p>
-Feature requests are also maintained in the Bugzilla database.
+Feature suggestions are also maintained in the Bugzilla database.
</p>
<p>
@@ -159,47 +272,33 @@
<a name="contribute"/>
<subsection name="How can I contribute to the Struts source code?">
-<p>
-Struts is distributed by <a href="http://apache.org/">
-The Apache Software Foundation</a>.
-These are the same people who distribute the Apache Web server.
-Like all ASF projects, Struts is managed as a "meritocracy",
-where everyone's contribution is welcome.
-Users can help other users through the
-<a href="http://jakarta.apache.org/site/mail.html">mailing lists</a>,
-<a href="http://issues.apache.org/bugzilla">report bugs</a>, and
-<a href="http://issues.apache.org/bugzilla">request new features</a>.
-Developers can
-contribute patches, new code, and documentation.
-The most active Developers may become
-<a href="http://jakarta.apache.org/site/roles.html">Committers</a>,
-who make the actual decisions about Strut's codebase.
-</p>
-
-<p>
-If you are new to open source development, see the
-<a href="http://jakarta.apache.org/site/getinvolved.html">
-How to get involved</a> page the main Jakarta site.
-</p>
-
-<p>
-A very good place to start is by <strong>reviewing the list of open issues</strong>
-and pending feature requests (<a href="#bugs">Bugzilla</a>).
-If you see an issue that needs a patch you can write,
-feel free to annex your patch.
-If you seen an issue that needs a unit test to prove its fixed,
-feel free to annex your test case.
-If someone has posted a patch to an issue you'd like to see resolved,
-apply the patch to your local development copy of Struts.
-Then let us know if it works for you, and if it does,
-cast your vote for the issue and its patch.
-</p>
-
-<p>
-If none of the pending issues scratch your itch,
-another good place to start is by <strong>contributing unit tests</strong>
-for existing features (even those that still work).
-</p>
+ <p>
+ A very good place to start is by <strong>reviewing the list of open issues</strong>
+ and pending feature requests (<a href="#bugs">Bugzilla</a>).
+ If you see an issue that needs a patch you can write,
+ feel free to annex your patch.
+ If you seen an issue that needs a unit test to prove its fixed,
+ feel free to annex your test case.
+ If someone has posted a patch to an issue you'd like to see resolved,
+ apply the patch to your local development copy of Struts.
+ Then let us know if it works for you, and if it does,
+ cast your vote for the issue and its patch.
+ </p>
+
+ <p>
+ If none of the pending issues scratch your itch,
+ another good place to start is by <strong>contributing unit tests</strong>
+ for existing features (even those that still work).
+ </p>
+
+ <p>
+ You can upload a proposed
+ <a href="http://jakarta.apache.org/site/source.html#Patches">patch</a>
+ to either the code or documentation by creating a feature request in
+ <a href="#Bugs">Bugzilla</a>.
+ <strong>After creating the ticket</strong>, you can go back and upload a
+ file containing your patch.
+ </p>
<p>
Our current approach to <a href="kickstart.html#tests">unit testing</a>
@@ -224,30 +323,51 @@
<a name="documentation"/>
<subsection name="How can I contribute to the documentation?">
+ <p>
+ The documentation is maintained in the <code>doc</code> folder of the
+ repository in a XML format.
+ To build just the documentation for a subproject,
+ change to the subprojects trunk directory and run 'maven site'.
+ </p>
+
<p>
The only difference is that the documentation is kept in XML rather than Java
source code.
Otherwise, all the same precepts and procedures pertain.
</p>
+ <p>
+ If you would like to help with the documentation, it is important to
+ provide patches and new pages in the XML source.
+ Otherwise, some other volunteer will have to do this for you, and it may
+ never get done.
+ (Sad but true.)
+ </p>
+
+ <p>
+ If you are submitting new material, it is important to decide exactly
+ where you would put this in relation to the rest of the documentation.
+ Again, someone has to figure that out before it can be added,
+ and that someone might as well be you.
+ </p>
+
+ <p>
+ If you are making a substantial contribution, such as a new HOW-TO,
+ please consider submitting a document in the XML format we use.
+ This will make it easier to add your contribution to the official
+ documentation so that it becomes part of a Struts distribution.
+ </p>
+
<p>
The trick to getting started is to download the nightly build and try building
-the documentation WAR.
-Then try adding your own XML page under doc/ to see if the build succeeds.
+the subproject's site.
+Then try adding your own XML page under xdocs/ to see if the build succeeds.
If it doesn't, it will report where the bad element is, much like it reports
where a bad programming expression is.
If it does, then your page should be available under target/documentation/.
</p>
<p>
-The website portion of the package is the root directory of doc/.
-The User Guide portion is under the userGuide/ folder.
-If the material you'd like to add doesn't fit right in with what's there,
-the best thing may to start a new section after the existing material.
-The navigation column can be found in the project.xml document.
-</p>
-
-<p>
To display markup, substitute &lt; for <.
The unmatched trailing > will be ignored.
Since it is XML, all elements also need to closed.
@@ -266,6 +386,13 @@
guru, if you happen to one of those.
</p>
+
+ <p>
+ You can also post documentation to the
+ <a href="wiki.apache.org/struts/">Struts Wiki</a>.
+ </p>
+
+
</subsection>
<a name="release"/>
@@ -398,36 +525,6 @@
</subsection>
-<a name="decisions"/>
-<subsection name="Who makes the final decisions regarding Struts">
-
-<p>
-The management of the Struts product is based on principles and practices used
-by creators of the Apache HTTPD server.
-Struts follows the
-<a href="http://jakarta.apache.org/site/guidelines.html">Project Guidelines</a>
-on the main Jakarta site.
-</p>
-
-<p>If you are new to this style of development,
-the Apache HTTPD Dev list is available in a
-<a href="mailto:dev-digest-subscribe@httpd.apache.org">digest form</a>.
-Even if you are not working on the HTTPD server yourself,
-it is interesting to watch how the HTTPD team works on the server.
-</p>
-
-<p>
-The Struts project has its own <a href="../using.html#Lists">DEV list</a>,
-where all of the decisions regarding Struts are made.
-Most development takes place via
-<a href="http://jakarta.apache.org/site/proposal.html#decisions/voting/items">
-Lazy Consensus</a>.
-Committers post most changes to the product unilaterally, using their own best
-judgment, and only discuss or vote upon controversial matters.
-Struts PMC members can veto with cause any change in an unreleased product.
-</p>
-
-</subsection>
</section>
<section>
Modified: struts/site/trunk/xdocs/mail.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/mail.xml?rev=278945&r1=278944&r2=278945&view=diff
==============================================================================
--- struts/site/trunk/xdocs/mail.xml (original)
+++ struts/site/trunk/xdocs/mail.xml Tue Sep 6 01:55:42 2005
@@ -220,7 +220,7 @@
</section>
<section>
<p class="right">
- <strong>Back to:</strong> <a href="using.html">Using Struts</a>
+ <strong>Back to:</strong> <a href="helping.html">How to Help FAQ</a>
</p>
</section>
</body>
Modified: struts/site/trunk/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/navigation.xml?rev=278945&r1=278944&r2=278945&view=diff
==============================================================================
--- struts/site/trunk/xdocs/navigation.xml (original)
+++ struts/site/trunk/xdocs/navigation.xml Tue Sep 6 01:55:42 2005
@@ -40,10 +40,6 @@
<menu name="Community">
<item
- name="Getting Involved"
- href="using.html"
- />
- <item
name="How to Help FAQ"
href="helping.html"
/>
Modified: struts/site/trunk/xdocs/volunteers.xml
URL: http://svn.apache.org/viewcvs/struts/site/trunk/xdocs/volunteers.xml?rev=278945&r1=278944&r2=278945&view=diff
==============================================================================
--- struts/site/trunk/xdocs/volunteers.xml (original)
+++ struts/site/trunk/xdocs/volunteers.xml Tue Sep 6 01:55:42 2005
@@ -227,15 +227,81 @@
<h4 id="husted">Ted Husted -- PMC Member</h4>
<p>
- <a href="http://husted.com/ted/">Ted Husted</a> is a developer,
- author, and mentor. He is a Member of the Apache Software
- Foundation and Struts Project Management Committee. Ted's books
- include JUnit in Action, Struts in Action, and Professional JSP
- Site Design. He has consulted with teams throughout the United
- States, including CitiGroup, Nationwide Insurance, and PepsiCo.
- Ted is currently working with the Oklahoma State Department of
- Environmental Services to improve their permitting system.
- </p>
+ In the late 1990s, I was working with a local PBS station to
+ improve their web presence. Like most stations, WXXI had an
+ annual fundraising auction. Each year, we would do a little
+ for the auction. At first, we posted a few static pages about
+ the "big ticket" items. The next year, we accepted "pre-bids"
+ on the more expensive items, using a JavaScript application.
+ </p>
+
+ <p>
+ Then, late in 1999, the CEO decided to do more with the auction
+ on the website. The next big step would be to accept bids for
+ all items online. A colleague recommended FileMaker Pro, and we
+ went to work automating the bid-taking process. For
+ "Spring MarketPlace 2000", we entered the telephone bids into
+ computers in the studio, and Internet users could enter their
+ own bids directly.
+ </p>
+
+ <p>
+ The system worked, but we ran into some walls that were
+ difficult to work around. We also wanted to expand the
+ system to do scheduling and inventory as well as bid taking.
+ So, I started looking for a new platform. I came close to
+ selecting PHP, but there were some cool new Java products,
+ like Resin and Jetty, coming out in 2000. I was impressed and
+ decided to go with Java.
+ </p>
+
+ <p>
+ At the time, web application frameworks for Java were a new
+ idea, and only a couple were available.
+ I stumbled upon Struts at Jakarta, and started posting
+ questions to the list. At first, the list traffic was so low,
+ I wasn't sure if the group was still active. But, answers
+ came, and so I kept on posting.
+ </p>
+
+ <p>
+ To help teach myself the framework, I started a "walking
+ tour" of the infamous MailReader application. I posted the
+ tour as I wrote it, and people kindly corrected my
+ understanding of how things worked as I went.
+ </p>
+
+ <p>
+ In December 2000, Craig was asking for volunteers to help
+ with the documentation. Mike Schachter and I raised our
+ virtual hands, we became Struts committers 006 and 007.
+ </p>
+
+ <p>
+ By the Spring of 2001, our new auction application was ready
+ to ship using the Struts 1.0 beta. We took over 50,000 bids on
+ 5,000 items with nary a hitch. We added an inventory module
+ for 2002, and the station continued to use the original
+ software unchanged through 2005.
+ </p>
+
+ <p>
+ Since joining Struts in 2000, I've become a Member of the Apache
+ Software Foundation and Struts Project Management Committee. My
+ books include JUnit in Action, Struts in Action, and
+ Professional JSP Site Design. I've consulted with Struts teams
+ throughout the United States, including CitiGroup, Nationwide
+ Insurance, and PepsiCo.
+ </p>
+
+ <p>
+ Currently, I'n working with the Oklahoma State
+ Department of Environmental Services to improve their permitting
+ system. We started the work in Java, but the enterprise
+ migrated to ASP.NET in 2004. Rather than quit the team,
+ I stuck it out. We are now working on a Struts subproject for
+ ASP.NET called OverDrive.
+ </p>
<h4 id="cedric">Cedric Dumoulin -- PMC Member</h4>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
For additional commands, e-mail: dev-help@struts.apache.org