This is where you will find the source for the Concourse website and overall documentation. All of our docs are written using the Booklit documentation engine.
Building the Docs Locally
Have Go v1.8+ installed and configured. You can find the relevant instructions for your platform of choice here: Go Getting Started
Clone this repository: https://github.com/concourse/docs
Set your GOPATH and initialize submodules
direnv allow # or source .envrc git submodule update --init --recursive
Compiling the Docs
Run the following:
build script will instruct Booklit to compile all the files under
html files. The files will then be dumped into your current working
directory, i.e. the root of this repo.
Viewing the docs in your browser
To run a server that will rebuild the docs as needed, pass
-s (port) like so:
./scripts/build -s 8000
You will be now be able to see the rendered site if you navigate to http://localhost:8000.