The Apache Drill website is built using Jekyll.

Developing and Previewing the Website

To preview the website on your local machine:

jekyll build --config _config.yml,_config-prod.yml
_tools/createdatadocs.py
jekyll serve --config _config.yml,_config-prod.yml

Note that you can skip the first two commands (and only run jekyll serve) if you haven't changed the title or path of any of the documentation pages.

One Time Setup for Last-Modified-Date

To automatically add the last-modified-on date, a one-time local setup is required:

In your cloned directory of Drill, in drill/.git/hooks, create a file named pre-commit (no extension) that contains this script:

  #!/bin/sh
  # Contents of .git/hooks/pre-commit

  git diff --cached --name-status | grep "^M" | while read a b; do
    cat $b | sed "/---.*/,/---.*/s/^date:.*$/date: $(date -u "+%Y-%m-%d")/" > tmp
    mv tmp $b
    git add $b
  done

Make the file executable.
```
   chmod +x pre-commit
```

On any page you create, in addition to the title: and parent:, you now need to add date: to the front matter of any file you create. For example:

      ---
      title: "Configuring Multitenant Resources"
      parent: "Configuring a Multitenant Cluster"
      date: 
      ---

Do not fill in or alter the date: field. Jekyll and git take care of that when you commit the file.

One Time Setup for Redirecting gh-pages

Locally install the jekyll-redirect-from gem:

 gem install jekyll-redirect-from

On any page you want to redirect, add the redirect_to: and the URL to the front matter. For example:

      ---
      title: "Configuring Multitenant Resources"
      parent: "Configuring a Multitenant Cluster"
      date: 
      redirect_to:
        - http://<new_url>
      ---

Compiling the Website

Once the website is ready, you'll need to compile the site to static HTML so that it can then be published to Apache. This is as simple as running the jekyll build command. The _config-prod.yml configuration file causes a few changes to the site:

The noindex meta tag is removed. We want the production site to be indexed by search engines, but we don't want the staging site to be indexed.
The base URL is set to /. The production site is at /, whereas the staging site is at /drill (convenient for previewing on GitHub Pages: http://apache.github.io/drill).

jekyll build --config _config.yml,_config-prod.yml
_tools/createdatadocs.py
jekyll build --config _config.yml,_config-prod.yml

Uploading to the Apache Website (Drill Committers Only)

Apache project websites use a system called svnpubsub for publishing. Basically, the static HTML needs to be pushed by one of the committers into the Apache SVN.

git clone -b asf-site https://git-wip-us.apache.org/repos/asf/drill-site.git ../drill-site
cp -R _site/* ../drill-site/
cd ../drill-site
git status
git add *
git commit -m "Website update"
git push

The updates should then be live: http://drill.apache.org.

Documentation Guidelines

The documentation pages are under _docs. Most files, in the YAML front matter, have three important parameters:

title: - This is the title of the page enclosed in quotation marks. Each page must have a unique title
date: - This field is needed for Jekyll to write a last-modified date. Initially, leave this field blank.
parent - This is the title of the page's parent page. It should be empty for top-level sections/guides, and be identical to the title attribute of another page in all other cases.

The name of the file itself doesn't matter except for the alphanumeric order of the filenames. Files that share the same parent are ordered alphanumerically. Note that the content of parent files is ignored, so add an overview/introduction child when needed.

Best practices: