google / asylo-site Goto Github PK

This repository contains the source code for the asylo.dev website.

Please see the main Asylo README file to learn about the overall Asylo project and how to get in touch with us.

• Working with the site
• Linting
• Thanks

The website uses Jekyll templates. Please make sure you are familiar with these before editing.

To run the site locally with Docker, use the following command from the top level directory for this git repo (e.g. pwd must be ~/github/asylo-site if you were in ~/github when you issued git clone https://github.com/google/asylo-site.git)

docker run -it --rm -v ${PWD}:/srv/jekyll -p 4000:4000 jekyll/jekyll:pages \
    jekyll serve -d /tmp/_site
# Then open browser with url localhost:4000 to see the change.

Some tests are included to make sure you are not introducing HTML errors or bad links.

docker run -it --rm -v ${PWD}:/srv/jekyll jekyll/jekyll:pages rake test
# You should see "HTML-Proofer finished successfully" in the output.

Alternatively, if you just want to develop locally without Docker/Kubernetes/Minikube, you can try installing Jekyll locally. You may need to install other prerequisites manually (which is where using the docker image shines). Here's an example of doing so for Mac OS X:

xcode-select --install
sudo xcodebuild -license
brew install ruby
gem update --system
gem install mdspell
gem install bundler
gem install jekyll
cd asylo-site
bundle install
bundle exec rake test
bundle exec jekyll serve

You should run scripts/linters.sh prior to checking in your changes. This will run 3 tests:

• HTML proofing, which ensures all your links are valid along with other checks.

• Spell checking.

• Style checking, which makes sure your markdown file complies with some common style rules.

If you get a spelling error, you have three choices to address it:

• It's a real typo, so fix your markdown.

• It's a command/field/symbol name, so stick some backticks around it.

• It's really valid, so go add the word to the .spelling file at the root of the repo.

Many thanks to @geeknoid for his help basing this website off the clean and elegant Istio.io.