Project Information

This document provides an overview of the various documents and links that are part of this project's general information:

• Community Roles and Processes
• Project Team
• Mailing Lists
• Issue Tracking
• Source Repository
• Continuous Integration
• Project License
• Documentation Repository

Mailing Lists

These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.

The Sling Users List is the preferred way of getting help with Sling. However, you can also Ask a Sling question on StackOverflow if you prefer.

Issue Tracking

This project uses JIRA a J2EE-based, issue tracking and project management application. Issues, bugs, and feature requests should be submitted to the following issue tracking system for this project.

The issue tracker can be found at http://issues.apache.org/jira/browse/SLING

Source Repository

This project uses Git to manage its source code. The source code is hosted on the ASF GitBox setup and replicated to Apache organisation on GitHub. As a developer you may push to either GitBox or GitHub. Note however that for GitHub to work you need to set up your GitHub account with two-factor authentication from the main GitBox page.

To check out the Sling source code, see the instructions from Getting and building Sling.

For additional information see Using Git with Sling.

Web Access

The source code can be accessed using either the GitHub or GitBox setup.

To list all modules on GitHub you can use this search query: https://github.com/apache/?q=sling, or see our list of repositories on this website.

Attic

A number of Sling modules that are not being developed further have been moved to the Sling Attic in the svn repository that we used until late 2017.

Now that the Sling codebase is split in multiple Git repositories, we'll probably keep such modules in place but mark them as being retired. We haven't had such a case since the move to Git, we will clarify once that happens.

Continuous Integration

Sling builds run automatically on the ASF's Jenkins instance, triggered by commits.

We maintain multiple build jobs, typically one or two per module. These are grouped into two views:

• Sling, which holds all Sling-related jobs
• Sling-Dashboard, which holds all Sling jobs needing attention, such as failed jobs.

More documentation regarding the Jenkins setup is available as wiki links from the views mentioned above.

Documentation Repository

The documentation website, in fact the very page that you are reading right now, is located at The Apache Sling Site Project. You can contribute without being an official project committer.

Submitting a patch to the Sling Site project

Create a Git patch:

1. Locally check out the git repository.
2. Edit the documentation, don't commit.
3. From the command line git diff > site.patch.

Submit your changes:

1. Navigate to the Jira issue tracker.
2. Create an account and/or login.
3. Create a ticket, enter a description and choose Documentation for Components.
4. Select the ticket, click more, select attach files and attach your Git patch.

Additionally there is a Github hosted Apache Sling Site Project Mirror which can be used to submit changes as well.

Submitting a pull request to the GitHub Sling Site mirror

Create the Pull Request:

1. Navigate to the Apache Sling Site Project Mirror.
2. Create an account and/or login.
3. Edit the documentation using the edit icon Fork this project and edit this file.
4. Once all changes are done click New pull request.
5. Select base fork:apache/sling-site base:master as the project to push to