From 56b6aef17219622aa6f2edbdaba27ef46bed10ab Mon Sep 17 00:00:00 2001 From: Julian Simioni Date: Sun, 5 May 2019 12:27:20 -0400 Subject: [PATCH] Add submodule documentation to Planet project Fixes https://github.com/pelias/docker/issues/90 --- projects/planet/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/projects/planet/README.md b/projects/planet/README.md index 58fbfed0..c5cffc2f 100644 --- a/projects/planet/README.md +++ b/projects/planet/README.md @@ -28,6 +28,10 @@ The minimum configuration required in order to run this project are [installing Please ensure that's all working fine before continuing. +## Acceptance tests + +This project uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to pull in the [pelias/acceptance-test](https://github.com/pelias/acceptance-tests/) repository to allow testing full planet builds. + ### Caveats A full planet build will require a street polylines file generated with Valhalla. Please see [the documentation](https://github.com/pelias/polylines/wiki/Generating-polylines-from-Valhalla) on how to perform that build. @@ -37,6 +41,9 @@ A full planet build will require a street polylines file generated with Valhalla To run a complete build, execute the following commands: ```bash +git submodule init +git submodule update + pelias compose pull pelias elastic start pelias elastic wait @@ -45,6 +52,7 @@ pelias download all pelias prepare all pelias import all pelias compose up + pelias test run ```