Add Layer / schema Documentation #368
Conversation
|
|
||
|
|
||
| Take a look or copy a standard layer like [building](https://github.com/openmaptiles/openmaptiles/tree/master/layers/building) to get started with your own layer. | ||
| A layer consists out of a **Layer** definition written in YAML format. |
There was a problem hiding this comment.
Grammar: remove word "out"
| ``` | ||
| make start-tileserver | ||
| ``` | ||
| And go to `localhost:8090` |
There was a problem hiding this comment.
On my system, this comes up as :8080, not sure where the 8090 comes from.
| | etl_diagram.png | TODO: EXPLAIN ME | | ||
| | mapping_diagram.png | TODO: EXPLAIN ME | | ||
| | update_park_polygon.sql | TODO: EXPLAIN ME | | ||
|
|
There was a problem hiding this comment.
Are we explaining how to create a layer for inclusion in OpenMapTiles, or how to create a custom layer that you aren't contributing? If it's going in the repository, ETL diagrams are definitely not optional.
| | park.yaml | Start point / General definition file. Contains `description`, `fields`, `buffer_size`, `schema`, `datasources`, ... | | ||
| | mapping.yaml | [Imposm3 mapping file](https://imposm.org/docs/imposm3/latest/mapping.html). Definition how and where the OSM Data schould be stored in the Database. | | ||
| | park.sql | Creates SQL functions to get the correct data from the database while tile-generation | | ||
|
|
There was a problem hiding this comment.
A description of the update process is needed here. Otherwise, tables will only get an initial load if any tables are created beyond the ones that imposm makes.
|
In some cases, a new map requirement can be addressed by adding a field to an existing layer. |
3 participants
This should explain and help beginners (like I'm) to understand how own layers can be created.
There are many TODOs and I can't solve them all, because I don't understand how some parts are working and what happing there. It would be very nice if you can help!
Openmaptiles Doc PR: openmaptiles/openmaptiles#1219
Openmaptiles Issue: openmaptiles/openmaptiles#1211