Fix mentor guide bullets. Added FAQ to header, fixed HTML left overs.
[incubator.git] / README.md
1 # Apache Incubator Website
2
3 ## Prerequisites
4
5 The website is built using JBake and a Groovy template.  The builds for the website do require internet access.
6
7 - Install JBake from http://jbake.org/download.html
8 - Create an environment variable `JBAKE_HOME` pointing to your JBake installation
9 - Ensure that you have a JVM locally, e.g. [OpenJDK](http://openjdk.java.net/install/)
10
11 ## Building & Running the site
12
13 There is a custom `bake.sh` file that is used to build the website.  You can call it with any of the [arguments you would pass to jbake](http://jbake.org/docs/2.5.1/#bake_command).
14 The easiest way to use it is to run `./bake.sh -b -s` this will start up JBake in a watching mode as you make changes it will refresh after a short period of time.
15 While working with it locally, you'll notice that the site URLs redirect to `incubator.apache.org`, to change this edit `jbake.properties` and uncomment the line referencing `localhost`
16
17 ## Jenkins Setup
18
19 Commits to the `jbake-site` branch are automatically checked out and built using `build_site.sh`.  Once this goes live those commits will go against `master`.  The jenkins job can be found at [https://builds.apache.org/view/H-L/view/Incubator/job/Incubator%20Site/](https://builds.apache.org/view/H-L/view/Incubator/job/Incubator%20Site/)
20 The result of the commits are pushed to the `asf-site` branch which are then published using `gitwcsub`
21
22 ## Asciidoctor
23
24 Most of the pages in the site are written using Asciidoctor.  While it is a form of asciidoc it does have some [syntax differences that are worth reviewing](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
25
26 ## Groovy Templates
27
28 The site templates are written in groovy scripts.  Even though the files end with `.gsp` they are not GSP files and do not have access to tag libraries.  You can run custom code in them, similar to what is done in [homepage.gsp](templates/homepage.gsp)