Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.23 KB

README.md

File metadata and controls

36 lines (28 loc) · 1.23 KB
Raw

Docker

This repository uses a Docker image that contains pandoc and pandoc filters used to translate the PartiQL documentation into html and pdf.

The Docker image is uploaded to Docker Hub https://hub.docker.com/r/partiqlteam/pandoc

Building the documentation

While in this folder execute

cd .. 
docker run -it --entrypoint "/bin/bash" -v `pwd`:/build partiqlteam/pandoc:1.0
cd /build
make
exit

The above steps will

  1. cd .. move to the parent directory; the root of all documentation
  2. docker run -it --entrypoint "/bin/bash" -v `pwd`:/build partiqlteam/pandoc:1.0 run docker such that
  3. --entrypoint "/bin/bash" start up a shell in the docker image
  4. -v `pwd`:/build mount the current directory, `pwd`, in the docker image as folder /build
  5. partiqlteam/pandoc:1.0 the name of the image
  6. cd /build this command is executed once you are inside the docker image and takes you to the build folder
  7. make run make to build the documentation
  8. exit if make completed successfully, exit the docker image

All generated documentation is inside the folder webapp. The folder exists in both the docker image as /build/webapp as well as your local filesystem as <REPO_ROOT>/docs/webapp.