isrddev/deriva-docs repository overview

⁠deriva-docs-docker

Docker image used for building the DERIVA platform documentation suite from the GitHub repo deriva-docs⁠.

⁠Installation

⁠With Docker Hub

Pull the image from Docker Hub using:

docker pull isrddev/deriva-docs

⁠From source

Clone this repository build the image using the following command:

docker build -t isrddev/deriva-docs .

⁠Usage

Run the following command on the docker image to automatically build and publish the documentation as the GitHub user isi-isrd-dev from the master deriva-docs⁠ branch.

• Note that in the default usage below, the GITHUB_TOKEN environment variable must be a valid token with read/write scopes for the default GitHub user isi-isrd-dev and the deriva-docs⁠ repo.
• The -e GITHUB_TOKEN=XXX may be omitted to only build the docs without the subsequent commit/push to GitHub.

docker run -it -e GITHUB_TOKEN=XXX isrddev/deriva-docs build

⁠Additional options

Other environment variables can be passed with the -e switch to override the GitHub account and branch used to pull/commit/push to the documentation repository:

• GITHUB_TAG: The branch/tag name of the deriva-docs⁠ repo to use for building.
• GITHUB_USER: The GitHub username to authenticate for pull/commit/push operations. Note that the GITHUB_TOKEN environment variable must be a valid access token for the user specified against the deriva-docs⁠ repo.
• GITHUB_EMAIL: The email address to use for GITHUB_USER. It is recommended that this email address match the registered email address for the GITHUB_USER or undesired commit behavior may occur.