Page History

...

See also: How to Help FAQ.

Documentation Workflow

Since projects like Struts wear our code "on our sleeve", there's always a discussion over whether the website should represent the latest documentation or the documentation for the "best available" release. Over the years, we've done it one way and the another, and now we do it both ways

The latest documentation for Struts 2.0.x is at

• http://struts.apache.org/2.x/^{Image Added}

You can get here by following the home link to the "2.x draft docs".

The documentation for (say) the Struts 2.0.9 release is archived at

• http://struts.apache.org/2.0.9/^{Image Added}

You can get here by following the link to the Struts 2.0.9 documentation.

The draft documentation is saved first to the Confluence wiki software at

• http://cwiki.apache.org/confluence/display/WW/^{Image Added}

It's then immediately converted to HTML, on an edit-by-edit basis, and kept at

• http://cwiki.apache.org/WW/home.html^{Image Added}

Then every hour or so, the cwiki site is synchronized with the the main site at

• http://struts.apache.org/^{Image Added}

When we vote a test build to a release (of any flavor: alpha, beta, GA), we archive the HTML version of the documentation for future reference. When a release is designated GA, we update the appropriate links on the main site to point to the archival copy.

Now, all this applies to the "documentation wiki". Since we bundle the HTML version of the documentation wiki with the release, we require authors to file a CLA, to ensure that we actually have distribution rights.

To cover all the bases, we also maintain a "community wiki", that is not bundled with the distribution.

• http://cwiki.apache.org/S2WIKI/home.html^{Image Added}

It's open to anyone who signs up for an account on Confluence. Sometimes, we do move documentation from the community wiki to the documentation wiki, if the author can a CLA.

Sadly, not everyone can file a CLA. Many organizations still use aggressive IP agreement that assign rights to our every stray thought to the company, 24/7. In fact, some organizations grant a special dispensation for the ASF so that their employees can file CLAs.