Adding the latest release of File Optimization
2 files changed
tree: 7616ccfd107bb58a8d98ce615cda6f2b36b228a9
  2. src/
  3. .gitignore
  4. .sling-module.json
  7. Jenkinsfile
  9. pom.xml

Build Status License

Apache Sling Website

This repository contains the content of the website, which moved in September 2017 from the Apache CMS to this JBake-generated site.

How to build and stage the site locally

Clone this repository, run the below Maven command, open http://localhost:8820/ and enjoy.

mvn clean package -Prun-site

This allows you to experiment with your changes before eventually publishing them.

How to publish the website

Each push to the master branch automatically regenerates and publishes the website to, see SLING-7180 for details. The corresponding Jenkins job is at

However, if for some reason you need to manually publish the website the instructions below need to be followed.

Clone this repository and run the below commands or equivalent:

# Build the site and review your changes
mvn clean package

# deploy the site
mvn clean package -Ppublish-site -Dmsg="<describe your changes>"

The ASF's gitpubsub mechanism then synchronizes that content to, usually within a few seconds. More details about the publication process can be found in the ASF Documentation about Project sites. If for some reason this process fails, you can use the self-service page from ASF Infra to trigger a resync of the git repo.

Note that the publish-scm goal might fail if you add lots of changes due to MSCMPUB-18. In that scenario you have to manually perform the git operations, see for instance this file at revision 3e58fbd7.

Variables in page content

Adding expandVariables=true to a page's front matter enables simple variables replacement, see the pageVariables map in templates code for which variables are supported or to add more variables. A pattern like ${sling_tagline} in page content is replaced by the sling_tagline variable if it exists, otherwise a MISSING_PAGE_VARIABLE marker is output.

Please use a sling. prefix for new site-related variables in, to differentiate from JBake built-in variables.

Syntax highlighting

The site uses highlight.js for that.

Highlighting can be disabled by specifying an unknown language in the <pre> blocks that are highlighted by default, like for example

<pre class="language-no-highlight">
This will not be highlighted.

Other Apache projects using JBake

It's sometimes useful to steal ideas get inspiration from other projects using similar tools, for now we know of:

JBake and other technotes

Useful scripts and commands

To find broken links use

wget --spider -r -nd -nv -l 5 http://localhost:8820/ 2>&1 | grep -B1 'broken link'

Deploying when git is configured with user.useConfigOnly = true

It it possible to configure git to not inherit or infer the and properties, to avoid the situation where an incorrect value is used.

However, this breaks site publishing as the git checkout no longer inherits the global configuration settings. To still be able to publish, the following steps are needed

mvn package -Ppublish-site -Dmsg="your-msg-here"
cd target/scm-checkout
git config
mvn package -Ppublish-site -Dmsg="your-msg-here"

We are publishing the site once, which creates the SCM checkout, and fails to push since no config is set. Then we manually configure this property in the SCM checkout and try publishing again. Be careful to avoid any clean operations with Maven since it will erase the initial checkout.