Editing the Documentation

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

I created Changes to the documentation can be requested to the issue tracker, or added to a page as a comment. To add comments, create an account on the Struts 2 Documentation Confluence space at cwiki.apache.org, but I don't seem to have editing privileges to the Struts 2 WW space.The WW . A volunteer with page editing privileges can then make the change by referring to the comment. (Confluence sends to the developers mailing list a daily summary of changes, including new comments.)

To request page editing privileges, first file a Contributor's License Agreement with the ASF. After CLA is submitted (fax is still best), you can request a karma upgrade on the dev list. After the CLA is submitted, it make take several days for it to be processed by the ASF Secretary (who is a part time volunteer, like everyone else around here). The roster of CLAs is available to ASF members, as well as at the bottom of this page, so we will know when it is processed.

The Struts 2 Documentation space is bundled with the Struts distribution, and, eventually, the content may be checked into an ASF repository. Accordingly, all volunteers working on the to this space must have a Contributor's License Agreement on file.

Once the CLA is on file, you can request a karma upgrade on the dev list.

CLA on file.

The project also hosts a second Confluence space, the Struts 2 wiki, which can be edited by anyone who creates a n account.

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 (smile)

The latest documentation for Struts 2.0.x is at

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

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

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

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

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.

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.

Next: Documentation Colophon