Skip to content

Add documentation about how to add a map layer#37

Open
leonardehrenfried wants to merge 2 commits intostadtnavi:hbg-mfdz-devfrom
leonardehrenfried:map-layer-docs
Open

Add documentation about how to add a map layer#37
leonardehrenfried wants to merge 2 commits intostadtnavi:hbg-mfdz-devfrom
leonardehrenfried:map-layer-docs

Conversation

@leonardehrenfried
Copy link
Copy Markdown
Collaborator

Comments welcome.

Comment thread docs/AddingAMapLayer.md Outdated
This layer takes a GeoJSON source and then converts it to the [Mapbox vector tile format](https://github.com/mapbox/vt-pbf).
This is a highly optimized format for sending geographic data to the client.

Take a note the the [`id` you give to your layer](https://github.com/mfdz/tilelive-roadworks-bw/blob/master/index.js#L85).
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo. And how about adding a small code example directly to this page?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean the source code of the layer? I'm not sure if a "small snippet" would contain the needed information but I can add it.

Comment thread docs/AddingAMapLayer.md Outdated
Take a note the the [`id` you give to your layer](https://github.com/mfdz/tilelive-roadworks-bw/blob/master/index.js#L85).
You will need it in the client in order to figure out which layer data should be processed in which UI component.

Once you have the layer source, add it to `hsl-map-server` like in the following PR: https://github.com/transportkollektiv/hsl-map-server/pull/1/files
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A short description would be helpful

Comment thread docs/AddingAMapLayer.md
## digitransit UI

This is where the main work needs to happen. The files you need to touch are:

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, some short code snippets would be great

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants