pelias / docker

Run the Pelias geocoder in docker containers, including example projects.
MIT License
338 stars 226 forks source link

docs: improve the documentation for pelias.json #142

Open missinglink opened 5 years ago

missinglink commented 5 years ago

Editing pelias.json for a custom project is not very well documented, or at least the documentation is spread over several repos.

I'll give a quick summary of the import sources:

geonames the country code defines which one of their files is downloaded, omitting a country code downloads the file which includes everything. https://download.geonames.org/export/dump/

openaddresses

These filenames are from the website http://results.openaddresses.io/?runs=all#runs on the left, IIRC they must be specified with the .CSV extension although the downloader is smart enough to know to download a .ZIP file of the same name.

openstreetmap

This is simply any .OSM.PBF file, usually from an extract provider like Geofabrik or from the OSM planet website.

whosonfirst

There is a property which allows us to filter their dataset for a region, you need to give it a WOF ID and the code takes care of enumerating all the records above and below that ID in the hierarchy. These ID values can be found from an existing Pelias instance (such as geocode.earth) or via https://spelunker.whosonfirst.org/ or the placeholder demo link found on the pelias/placeholder repo.

TIGER

Is only applicable to the USA and only when building the interpolation service, there is more information in the readme about how to select states/counties.

I think in general all of this is documented in the individual importer repo readme but it's fairly fragmented right now making it hard to follow.

We should have a document somewhere which talks about how to edit pelias.json