Getting Started

The script to build the site expects to be run with the repository directory as the current directory. So, for example, if you are building the Connect web site, you could do this:

git clone [email protected]:Linaro/Connect.git
cd Connect
./build-site.sh

As a precursor to actually building the site, the process runs jekyll doctor to ensure that there are no "hidden" problems with the source material, such as multiple source pages generating the same destination page.

By default:

• the build script will use the linaroits/jekyllsitebuild container tagged as "latest". If you want to make changes to the container and test them against a site build, set JEKYLLSITEBUILD to the desired tag.

• the site will be built as a staging site. If you want to build the production version, JEKYLL_ENV must be set to production (case-sensitive) before running any script.

• the build script will put the output from the Jekyll build process in a directory named by the destination attribute in the Jekyll configuration. This will typically be staging.<site> or production.<site>, and that is controlled by the previous note.

As noted in Ruby Gems, the build container includes all of the gems being used by each site maintained by Linaro. If you modify the Gemfile file in a site repository, you must make a corresponding change to the Dockerfile in this repository otherwise the change you are making may cause the site not to build.