This website is written using a static website generator called Jekyll. To work with editing this website you will need to install it. In short, Jekyll uses a combination of templated HTML files and Markdown to compile the final site. Generally, the content itself lies within the Markdown files, and the HTML is for layout. A full tutorial about how to use Jekyll is out of the scope of this document, but, for our purposes, only Markdown will be edited.
The website is managed using git. Clone the site as usual
➤ git clone https://git-wip-us.apache.org/repos/asf/incubator-asterixdb-site.git
You will notice lots of Markdown files and HTML templates in the repository root. The compiled content of the website itself is served from the content/ folder in this repository. That is to say, that the actual content of the website itself, as well as its sources are stored in the same repository. Additionally, the main branch on this repository is asf-site and not master
Gerrit is used to submit code reviews for the website just as it is with the main codebase. The main difference the site is not strictly subject to code reviews.
To add the Gerrit repository for this site, add it as a normal git remote:
➤ git remote add gerrit ssh://YOU@asterix-gerrit.ics.uci.edu:29418/incubator-asterixdb-site
The general overview is as follows:
For whichever section of the site you want to edit, go ahead and do so with the text editor of your choice. Then, to see what your change looks like, in the repository root, execute:
➤ jekyll serve --watch
This sets up a small integrated web server and compiles the site dynamically as it is edited. Once you are satisfied with how the site looks, go ahead and commit your changes with git.
Right now git gerrit submit isn't used for the website, so you must construct the proper commit for Gerrit by hand. In your commit message, be sure to include a Change-Id footer that is unique to your change. You may take previous Change-Id: footers as an example.
Once you have made your commit, push it to Gerrit for review:
➤ git push gerrit HEAD:refs/for/asf-site
If no Change-Id is provided, “ERROR: missing Change-Id in commit message footer” is returned when attempting to push to Gerrit. The error description also contains a) a proposal for a Change-Id that can be pasted to the commit message and b) instructions how to install a commit-msg hook into the local git repository that will automatically add a Change-Id.
When the submitted review is committed in Gerrit, pull it and overwrite your current asf-site branch:
➤ git pull gerrit
Then, push the exact commit from the Gerrit web interface to the ASF git repository. Do this with care! ASF git doesn't allow hard resets on branches, so whatever you push here is final.
➤ git push origin (SHA1 of submitted commit)