...
Prerequisites:
- Ruby version 2.02+
sudo gem install bundler
sudo gem install jekyll
...
- Clone the repo associated with the PR
- From incubator- metron/site execute
bundle install
bundle exec jekyll serve
Navigate to http://localhost:4000 to review the site
This will create the static site in the target directory.
...
- From master, execute the following from incubator- metron/site
bundle install
bundle exec jekyll serve
...
- Ensure that the website comes up on http://localhost:4000 and exit whenever that is done
- Save off a zipped copy of incubator- metron/site/target (you don't want a parent directory in the zip itself since we unzip it right into the site branch directory)
- cd metron/site/target
- zip -r /tmp/metron-site.zip .
- Checkout the asf-site branch
- Ensure at git status says you have no untracked files. Sometimes a checkout will bring along some rogue files that are untracked in master such as target directories. You can run the following command to clean up.
- git clean -fd
- If you see your branch is behind, do a `git pull` before updating the site branch with local changes.
- Unzip the copy of the target into incubator-metronmetron
- unzip /tmp/metron-site.zip
- Ensure that the change looks right by running python -m SimpleHTTPServer and navigating to http://localhost:8000
- Commit locally with a commit message that references the JIRA. e.g. METRON-177: Sync'ing asf-site from the generated code on master.
- Push to apache via git push apache asf-site (assuming you named the apache remote repo 'apache')
Validate the Live Site
After pushing the asf-site branch, go to the live site and reload (this may take a few seconds to go live). Click around and ensure the live site looks as expected.
Troubleshooting
If you have trouble installing Jekyll you may need to add some additional tools to get it to compile. This worked for me on Mac OSX 10.13.1 (High Sierra)
...
, Homebrew 1.5.3, Ruby 2.5.0p0. (Skip the ruby install if you already have it configured properly.)
brew install ruby
brew install autoconf
brew install automake
brew install libtool