This repository contains the content of the http://sling.apache.org/ website, which moved in September 2017 from the Apache CMS to this JBake-generated site.
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.
Each push to the master branch automatically regenerates and publishes the website to https://sling.apache.org, see
SLING-7180 for details. The corresponding Jenkins job is at https://builds.apache.org/job/Sling/job/sling-site/job/master/
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 http://sling.apache.org, 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.
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 jbake.properties, to differentiate from JBake built-in variables.
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.
</pre>
It's sometimes useful to steal ideas get inspiration from other projects using similar tools, for now we know of:
- Tamaya - https://github.com/apache/incubator-tamaya-site
- OpenNLP - https://github.com/apache/opennlp-site
- Incubator - https://github.com/apache/incubator
- Currently using 2.6.5 via the
jbake-maven-plugin, see under/bin, docs at http://jbake.org/docs/2.6.5 - That version of JBake uses Flexmark as parser for Markdown and Pegdown extensions
- The templates use the Groovy Markup Template Engine, other examples are provided at https://github.com/jbake-org/jbake-example-project-groovy-mte
To find broken links use
wget --spider -r -nd -nv -l 5 http://localhost:8820/ 2>&1 | grep -B1 'broken link'
It it possible to configure git to not inherit or infer the user.name and user.email
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 user.email [email protected]
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 user.email 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.