README.md

Files

The actual documentation files live in the /source/includes directory.

Running Slate

Using slatedocs/slate Docker image

If you wish to run the development server for Slate to aid in working on the site, run:

docker run --rm --name slate -p 4567:4567 -v $(pwd)/source:/srv/slate/source slatedocs/slate serve

and you will be able to access your site at http://localhost:4567 until you stop the running container process.

Using a custom image that supports live reloading

To enable live reloading during development, run

make serve

This will create a new Docker image based on the Dockerfile in this repo. The image will be called adasupport_slate

The underlying command to build the image is

docker-compose -f docker-compose.serve.yml build

and to start the container with the development server

docker-compose -f docker-compose.serve.yml up

This image differs from slatedocs/slate because it contains an additional dependency middleman-livereload which enables the live reloading. The dependency is added in the Gemfile in this repo.

Things to note

• Note that it can take up to 10 minutes for this image to build for the first time.
• There could already be an active container called slate on your machine and this could cause the make command to fail. You can remove the old container by running docker container rm slate -f

Deployment

Your changes will automatically be deployed after merging into the master branch

References:

• https://hub.docker.com/r/slatedocs/slate
• https://github.com/slatedocs/slate/wiki/Deploying-Slate