lix-project/hydra
3
0
Fork 6
Code Issues 2 Pull requests 1 Packages Projects Releases Wiki Activity

manual: document working on docs

Browse source
This commit is contained in:
Graham Christensen 2021-04-05 15:39:49 +00:00
parent d764eabfcc
commit 0ddf3d43f2
3 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Procfile
View file

@ -3,3 +3,4 @@ hydra-queue-runner: ./foreman/start-queue-runner.sh
hydra-evaluator: ./foreman/start-evaluator.sh hydra-evaluator: ./foreman/start-evaluator.sh
hydra-notify: ./foreman/start-notify.sh hydra-notify: ./foreman/start-notify.sh
postgres: ./foreman/start-postgres.sh postgres: ./foreman/start-postgres.sh
manual: ./foreman/start-manual.sh

6
doc/manual/src/hacking.md
View file

@ -44,6 +44,12 @@ if run with high parallelism [due to an issue in
`Test::PostgreSQL`](https://github.com/TJC/Test-postgresql/issues/40) `Test::PostgreSQL`](https://github.com/TJC/Test-postgresql/issues/40)
causing database ports to collide. 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 ## Building
To build Hydra and its dependencies: To build Hydra and its dependencies:

6
foreman/start-manual.sh Executable file
View file

@ -0,0 +1,6 @@
#!/bin/sh
mdbook serve \
--port 63332 \
--dest-dir $(pwd)/.hydra-data/manual \
$(pwd)/doc/manual/