README.md

Documentation Platform Docker File

This project contains the Docker file required to build the documentation platform Docker image and is based on an Alpine Linux installation with:

• Bash
• MkDocs with MkDocs Material theme.
• Node
• Python
• Pip
• AWS CLI
• Yarn
• NPM packages:
  • markdownlint-cli
  • write-good
  • markdown-spellcheck
  • phantomjs-prebuilt.

Prerequisites

Install Docker to run docker commands.

Building the Docker Image

To build the documentation platform Docker image, run:

docker build -t {imagename} --build-arg SOURCE_COMMIT=$(git rev-parse --short HEAD) .

Note:

• {imagename} can be any string.
• Syntax shown above works in bash.

Log in to the Docker Image

To log in to the previously built Docker image, run:

docker run -ti {imagename} sh

{imagename} can be any string.