|author||Zoran Regvart <firstname.lastname@example.org>||Sun Mar 03 16:19:37 2019 +0100|
|committer||Zoran Regvart <email@example.com>||Wed Apr 17 22:53:02 2019 +0200|
chore: GitHub deployments Creates a GitHub deployment for previews and staging environment.
This is a site generator project for Apache Camel. It generates static HTML and resources that are to be published.
Tools used to generate the website:
contentfolder and applies templates from
layoutsfolder and together with any resources in
staticfolder generates output in the
You can build the website locally using the tools
If you can not use these tools on your local machine for some reason you can also build the website using Maven as described in section “Build with Maven”.
Make sure that you have Node.js (herein “
$ node --version
If this command fails with an error, you do not have Node installed.
This project requires the Node LTS version 10 (e.g., v10.15.2).
Please make sure to have a suitable version of Node installed. You have several options to install Node on your machine.
Now that you have Node 10 installed, you can proceed with checking the Yarn installation.
You will need Yarn installed, which is the preferred package manager for the Node ecosystem.
You should install Yarn globally using the following command:
$ npm install -g yarn
npm is the Node package manager that comes with the default Node installation. So when you have Node installed you should also be able to use the
Now that you have the prerequisites installed, you can fetch and build the camel-website project.
Clone the Apache Camel Website project using git:
$ git clone https://github.com/apache/camel-website.git
The command above clones the Apache Camel Website project. After that you can switch to the new project folder on your filesystem.
First step is to build the Antora ui theme used for the Apache Camel website. The theme sources are located in antora-ui-camel.
In that folder execute:
$ yarn install // needed only once, or if dependencies change $ yarn build // to perform the ui theme build
You should see the Antora theme bundle generated in in antora-ui-camel/build/ui-bundle.zip.
The Camel Antora UI theme should not be a subject to change very frequently. So you might execute this once and never come back.
Building the website requires the built Antora Camel UI theme bundle. Please check that the theme bundle exists in antora-ui-camel/build/ui-bundle.zip.
To build the website go to the project root folder and run:
$ yarn install // needed only once, or if dependencies change $ yarn build // to perform the build
You can preview the Apache Camel website on your local machine once you have the generated website available in the
Hugo can start a simple web server serving the generated site content so you can view it in your favorite browser.
$ yarn preview
and you will be provided with a web server running the site on http://localhost:1313/
Point your favorite browser to
http://localhost:1313/ and you will see the Apache Camel website.
The project provides a simple way to build the website sources locally using the build tool Maven.
The Maven build automatically downloads the tool binaries such as
yarn for you. You do not need to install those tools on your host then. The binaries are added to the local project sources only and generate the website content.
As the Maven build uses pinned versions of
yarn that are tested to build the website you most likely avoid build errors due to incompatible versions of
Node.js tooling installed on your machine.
Make sure that you have Maven installed.
$ mvn --version
If this command fails with an error, you do not have Maven installed.
When building everything from scratch the build executes following steps:
Node.jsbinaries to the local project
You can do all of this with one single command:
$ mvn package
The whole process takes up to five minutes (time to grab some coffee!)
When the build is finished you should see the generated website in the
When rebuilding the website you can optimize the build process as some of the steps are only required for a fresh build from scratch. You can skip the ui theme rendering (unless you have changes in the theme itself).
$ mvn package -Dskip.theme
This should save you some minutes in the build process. You can find the updated website content in the
When rebuilding the website the process uses some cached content (e.g. the fetched doc sources for Camel and Camel K or the Antora ui theme). If you want to start from scratch for some reason you can simply add the
clean operation to the build which removes all generated sources in the project first.
$ mvn clean package
Of course this then takes some more time than an optimized rebuild (time to grab another coffee!).
The Apache Camel website is composed of different sources. So where to add and contribute changes in particular?
The site main menu is defined in the top level configuration config.toml. You can add/change menu items there.
The basic website content is located in content. You can find several different folders representing different areas of the website:
Layout related changes go into layout folder where you will find HTML templates that define the common layout of the different page categories including footer and header templates.
The Antora UI theme basically defines the look and feel of the website. You can find the theme sources within this repository in antora-ui-camel.
You need to rebuild the Antora UI theme in order to see your changes reflected locally.
The Apache Camel website includes documentation sources from other github repositories. Content sources are defined in site.yml.
At the moment these sources are documentation sources form Camel and Camel K. These are basically the component reference docs and the Camel user manual. In case you want to change something here please go to the respective github repository and contribute your change there.
Your changes in these repositories will automatically get visible on the website after a site rebuild.