From 0ddf3d43f2db0565aa611da52a1e1dc72fe75d1b Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Mon, 5 Apr 2021 15:39:49 +0000 Subject: [PATCH] manual: document working on docs --- Procfile | 1 + doc/manual/src/hacking.md | 6 ++++++ foreman/start-manual.sh | 6 ++++++ 3 files changed, 13 insertions(+) create mode 100755 foreman/start-manual.sh diff --git a/Procfile b/Procfile index 45a1e8fe..f9da41e5 100644 --- a/Procfile +++ b/Procfile @@ -3,3 +3,4 @@ hydra-queue-runner: ./foreman/start-queue-runner.sh hydra-evaluator: ./foreman/start-evaluator.sh hydra-notify: ./foreman/start-notify.sh postgres: ./foreman/start-postgres.sh +manual: ./foreman/start-manual.sh diff --git a/doc/manual/src/hacking.md b/doc/manual/src/hacking.md index dabc7169..c22b7530 100644 --- a/doc/manual/src/hacking.md +++ b/doc/manual/src/hacking.md @@ -44,6 +44,12 @@ if run with high parallelism [due to an issue in `Test::PostgreSQL`](https://github.com/TJC/Test-postgresql/issues/40) causing database ports to collide. +## Working on the Manual + +By default, `foreman start` runs mdbook in "watch" mode. mdbook listens +at [http://localhost:63332/](http://localhost:63332/) by default, and +will reload the page every time you save. + ## Building To build Hydra and its dependencies: diff --git a/foreman/start-manual.sh b/foreman/start-manual.sh new file mode 100755 index 00000000..5ad78265 --- /dev/null +++ b/foreman/start-manual.sh @@ -0,0 +1,6 @@ +#!/bin/sh + +mdbook serve \ + --port 63332 \ + --dest-dir $(pwd)/.hydra-data/manual \ + $(pwd)/doc/manual/