This project contains the the sources for the CUBA Platform guides provided on https://cuba-platform.com/guides

1. create a file in _drafts directory (a good starting point is guide-template.adoc).
2. write the guide

Every guide that is under _posts in the master branch of this project will get picked up as a guide and be served by Github pages.

The normal workflow is to create a not-complete guide in the _drafts directory as well as using PRs in this repository when it comes to releasing a guide.

In order to run locally, it is required to have the Jekyll based environment running.

Mainly following the setup instructions on: https://jekyllrb.com/docs/#instructions

After ruby, jeykll and bundler is installed, execute bundle install in the project directory to get all required dependencies.

With that everything is setup in order to run jekyll locally

$ jekyll serve --config _config.yml

Then http://127.0.0.1:4000/ will serve the local guides

Normally it is useful to create the guide as a draft. In order to see them as well in the output, add the --drafts flag:

$ jekyll serve --drafts --config _config.yml 

Create builder image with required dependencies:

docker build -f docker/builder/Dockerfile -t cuba-platform/guides-builder . 

Build:

docker run --rm --volume="$PWD:/srv/jekyll" cuba-platform/guides-builder jekyll build

Serve:

docker run --rm --volume="$PWD:/srv/jekyll" -p 4000:4000 cuba-platform/guides-builder jekyll serve