Working with the cortex-helm-chart docs

Table of contents

1. Setup
2. Preview

---

Setup

The cortex-helm-chart docs uses jekyll with the just-the-docs theme. Unfortunately due to security concerns GitHub doesn’t let us preview from pull requests or different branches. However GitHub created this guide on how to test your changes locally.

Preview

After installing ruby and bundle. Simply change into the /docs folder of the cortex-helm-chart and run:

bundle exec jekyll serve --incremental --livereload

For further options you can consult bundle exec jekyll serve --help