Skip to content

Commit

Permalink
Merge pull request pelias#99 from pelias/planet-acceptance-test-docs
Browse files Browse the repository at this point in the history
Add submodule documentation to Planet project
  • Loading branch information
orangejulius authored May 13, 2019
2 parents cccbb6d + 56b6aef commit ecea08e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions projects/planet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -45,6 +52,7 @@ pelias download all
pelias prepare all
pelias import all
pelias compose up

pelias test run
```

Expand Down

0 comments on commit ecea08e

Please sign in to comment.