Apache

Documentation

Overview

The documentation is split into different parts:

How you can contribute

We're on the way to improve the documentation, but it's a long way. If you would like to contribute to the documentation you are very welcome. Please directly post your proposals to the public wiki or post your suggestions to the mailing list.

How the documentation is generated

The basic documentation of Sling is made up of four parts:

  1. The Sling Site at http://sling.apache.org/ (you are here)
  2. The Public Wiki at http://cwiki.apache.org/SLING
  3. The JavaDoc
  4. The Maven plugin documentation

This page is about how this documentation is maintained and who is allowed to do what.

The Sling Website

The website is built from a dedicated repository as described Project Information.

The Public Wiki

The public wiki of Sling is available at http://cwiki.apache.org/SLING and is maintained in the Confluence space SLING. Everyone can create an account there. To gain edit rights please ask via the mailing list. Any of the administrators listed in the Space Overview can give you access.

The JavaDoc

With every major release of Sling the JavaDoc of all containing bundles are published below http://sling.apache.org/apidocs/. The script for generating this aggregation JavaDoc is in the sling-tooling-release repo, at generate_javadoc_for_release.sh.

In addition every released bundle is released together with its JavaDoc (which is also pushed to Maven Central).

The Maven Plugin Documentation

For the most important Maven Plugins the according Maven Sites (generated with the maven-site-plugin) are published at http://sling.apache.org/components/. The description on how to publish can be found at Release Management.