Apache Unomi website

Clone this repo:
  1. 6b604e5 Merge pull request #37 from niallkp/master by Serge Huber · 4 months ago master
  2. eef665a UNOMI-871 Remove Google Analytics from the unomi Website by Niall Pemberton · 4 months ago
  3. 05f8789 Apache Unomi 2.6.1 Release website update by jsinovassin · 5 months ago
  4. c88dcd5 Apache Unomi 2.6.0 Release website update by jsinovassin · 5 months ago
  5. b4e2b13 UNOMI-855 : Set documentation following release of Unomi (#36) by David Griffon · 6 months ago

Apache Unomi Website source repository

This project contains the Apache Unomi Website. The website is generated using Jekyll framework with Liquid templates.

Configuration

Jekyll Config

Can be found in _config YAML file

source: src/main/webapp
destination: target/site

Data config

Can be found in _data folder This contains some variables used to replace placeholders in the site.

Build

You need a machine with Jekyll or Docker to build the website.

Checkout the current project:

git clone https://github.com/apache/unomi-site

Build with Jekyll

jekyll build

Build with Docker

See Jekyll Docker's images documentation. The Docker image provides all Ruby and Jekyll resources to avoid to install them locally. Note that the version used of Jekyll is set to 4.2.0 as the newer images have an issue with a missing dependency.

 docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -p 4000:4000 \
  jekyll/jekyll:4.2.0 \
  jekyll build 

The generated site will be in the folder target/site

Publish

To publish the local website to the production location (https://unomi.apache.org/), you have to use: Do not use the clean maven goal to not remove the previous generated site.

mvn install scm-publish:publish-scm -Dusername=YOUR_APACHE_USERNAME -Dpassword=YOUR_APACHE_PASSWORD

Local build with local server

Run the following command

docker run --rm \
  --volume="$PWD:/srv/jekyll:Z" \
  -p 4000:4000 \
  jekyll/jekyll:4.2.0 \
  jekyll serve 

Then access to http://localhost:4000/ to access the site. Note that source changes are detected and apply automatically.