Apache Sling :: Documentation
documentation
community
pmc
modules
Documentation
Overview
The documentation is split into different parts:
Getting Started
, the right place to start!
The Sling Engine
, all about the heart of Sling
Development
, how do I get and develop with Sling
Bundles
, which bundle delivers which features to Sling
Tutorials & How-Tos
Wiki
Configuration
API Documentation
, the javadoc of the API exposed by Sling
More than 300 modules. No kidding.
As our
list of Git repositories
indicates, Sling consists of more than 300 modules.
Their importance and maturity varies, and we do our best to keep this information up to date,
marking modules as deprecated
once they stop being useful.
Some of these modules have their documentation in their Git repositories, linked from the
repositories list page
, while others have at least part of their documentation
on this website
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:
The Sling Site at https://sling.apache.org/ (you are here)
The Public Wiki at https://cwiki.apache.org/SLING
The JavaDoc
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
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
. 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
. The description on how to publish can be found at
Release Management
- ( Documentation )