blob: 7ecf93660661b0cfe0b2910a7c260b1e91e05d6a [file] [log] [blame]
= Apache James website
This repository is used for storing (some) content for[Apache James] website.
It's also used to build and publish the website.
== How to build the website
We use[Antora] as a tool to manage and generate the website.
We use[Gradle] as a tool to drive / automate the tasks for generating, aggregating and publishing the website.
=== Why Antora?
Antora lets us aggregate multiple documentation sources, across multiple versions and publish them as a single website.
Documentation for each Apache James component is kept and versioned alongside the code for it.
=== Why Gradle?
Gralde allows us to autoamte the tasks that we do when publishing a website.
We write gradle tasks for building and publishing the website.
We can run those tasks locally and inside our CI infrastructure:[Apache Builds].
More specifically, we use Gradle to:
* Download and install a specific version of[NodeJS] using[Gradle Node Plugin]
* Install a local version of Antora
* Use a Gradle task to call build the website with Antora
By using this specific flow, you only need `git`, `Java` and shell access to build the website.
All other dependencies are installed automatically by Gradle.
Even Gradle is downloaded and installed using the Gradle wrapper script.
== How to build the website
# To build the website run
./gradlew clean build
# The website is located here
cd doc-sites/build/site
== How to customize the theme for the documentaion
The documentation website is based on[Antora].
We have added[antora-ui-default] project as a git subtree under `antora-ui`.
`./gradlew :antora-ui:build` will assemble the `antora-ui/build/` archive required for the website.
All the steps are automated as Gradle tasks in that project.
All you have to do is change the css and html files and then rebuild the project.
The antora-ui project has a preview mode: `/.gradlew gulpPreviewTheme`
# antora-ui-default was added like this. You should be able to pull some changes from upstream
git subtree add --prefix antora-ui master --squash
=== Related links
*[A git subtree tutorial].
*[Antora UI keys]