Skip to content

Updating docs for Terrain v2#151

Merged
nvkelso merged 48 commits intomasterfrom
iandees/v2-docs
Nov 14, 2017
Merged

Updating docs for Terrain v2#151
nvkelso merged 48 commits intomasterfrom
iandees/v2-docs

Conversation

@iandees
Copy link
Copy Markdown
Member

@iandees iandees commented Jul 26, 2017

@iandees
Copy link
Copy Markdown
Member Author

iandees commented Jul 26, 2017

I started off with listing the new sources based on the stuff listed as completed in https://github.com/tilezen/joerd/projects/1.

Comment thread docs/data-sources.md

The underlying data sources are a mix of:

- [CDEM](http://geogratis.gc.ca/api/en/nrcan-rncan/ess-sst/c40acfba-c722-4be1-862e-146b80be738e.html) (Canadian Digital Elevation Model) in Canada, with variable spatial resolution (from 20-400 meters) depending on the latitude.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please make this list alphabetical.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Sounds good! It seemed to be ordered by resolution, so I was going with that. Alpha it is!

Comment thread docs/data-sources.md Outdated

These source images are composited to form tiles that make up the Mapzen Terrain Tiles service. To determine exactly which images contributed to Mapzen Terrain Tiles in a particular area, you can download the footprints database and use it with a GIS program like [QGIS](http://www.qgis.org/) to inspect which of these sources were used.

To further assist in determining which sources contributed to an individual tile, each tile in the service has an `X-Imagery-Sources` header listing the sources that contributed to the tile. Each entry in the comma-separated list follows the pattern `source/filename.tif`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

To cut down on support requests, please provide an example with say srtm and and ned and how to x-walk between the tables elsewhere in this page and the footprint database to determine things like source resolution versus tile pixel size.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

@nvkelso I added an example below this paragraph, but it's not clear to me if I touched on what you were getting at.

@iandees
Copy link
Copy Markdown
Member Author

iandees commented Jul 27, 2017

@nvkelso want me to track down license and attribution info and add to the attribution doc, too?

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Jul 27, 2017

want me to track down license and attribution info and add to the attribution doc, too?

@iandees Yes, please.

Comment thread docs/data-sources.md Outdated
These source images are composited to form tiles that make up the Mapzen Terrain Tiles service. To determine exactly which images contributed to Mapzen Terrain Tiles in a particular area, you can download the footprints database and use it with a GIS program like [QGIS](http://www.qgis.org/) to inspect which of these sources were used.

* [PostgreSQL Dump](https://example.com) (8.4MB, gzipped)
* [GeoJSON](https://example.com) (5.3MB, gzipped)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

List GeoJSON first (before PostgreSQL Dump) since it can open directly in QGIS listed in prior paragraph.

Comment thread docs/data-sources.md
* [GeoJSON](https://example.com) (5.3MB, gzipped)

### Source headers

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Consider linking to explanation of HTTP headers, like https://en.wikipedia.org/wiki/List_of_HTTP_header_fields

Comment thread docs/attribution.md Outdated

[Released](https://data.linz.govt.nz/layer/1768-nz-8m-digital-elevation-model-2012/) by [LINZ](https://data.linz.govt.nz/), licensed under [Creative Commons Attribution 3.0 New Zealand](https://data.linz.govt.nz/license/attribution-3-0-new-zealand/).

Attribution statement: Copyright 2011 Crown copyright (c) Land Information New Zealand and the New Zealand Government. All rights reserved
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

These should follow the format, wrapped to ~80 char: Attribution statement header on one line, then quoted markdown text for the actual statement.

Attribution statement:

Copyright 2011 Crown copyright (c) Land Information New Zealand and the
New Zealand Government. All rights reserved

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

None of the other statements follow this wrapped format. Do you want me to update those, too?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

More specifically, the 80-char wrapping isn't there.

Comment thread docs/data-sources.md Outdated
- [3DEP](http://nationalmap.gov/elevation.html) (formerly NED) in the United States, 10 meters outside of Alaska, 3 meter in select land and territorial water areas
- [SRTM](https://lta.cr.usgs.gov/SRTM) globally except high latitudes, 30 meters in land areas
- [GMTED](http://topotools.cr.usgs.gov/gmted_viewer/) globally, coarser resolutions at 7.5", 15", and 30" in land areas
- [ArcticDEM](http://nga.maps.arcgis.com/apps/MapSeries/index.html?appid=cf2fba21df7540fb981f8836f2a97e25) strips of 5 meter mosaics across the majority of the land north of 60° latitude
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Mention affected countries and callout Alaska here.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Nice graphic for posterity from here:

image

Comment thread docs/data-sources.md Outdated
- [data.gov.uk](http://environment.data.gov.uk/ds/survey/index.jsp#/survey), 2 meters over most of the United Kingdom
- [data.gv.at](https://www.data.gv.at/katalog/dataset/b5de6975-417b-4320-afdb-eb2a9e2a1dbf), 10 meters over Austria
- [ETOPO1](https://www.ngdc.noaa.gov/mgg/global/global.html) to fill in ocean bathymetry at 1'
- [EUDEM](https://www.eea.europa.eu/data-and-maps/data/eu-dem#tab-original-data) in most of Europe at 30 meter resolution
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Besides saying generally "Europe", please also list all affected countries. I know it's a long list, but someone will be searching for their country name.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I noticed that the UK was listed as being covered in the EUDEM metadata even though that wasn't in our footprints database, so I re-ran the UK-coverage tile and added it back 👍 .

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Jul 27, 2017

Doesn't need to be full list, but at least point people over to the full sources list.

(This area is also where a live slippy map could be embedded.) deferred

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Jul 27, 2017

Terrain tiles were built during 2016Q2 and 2016Q3 based on available sources at that time. Regular updates are not planned.

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Jul 27, 2017

Comment thread docs/attribution.md
### data.gv.at Digitales Geländemodell (DGM) Österreich

[Released](https://www.data.gv.at/katalog/dataset/b5de6975-417b-4320-afdb-eb2a9e2a1dbf) by [data.gv.at](https://www.data.gv.at/), licensed under [Creative Commons Namensnennung 3.0 Österreich](https://creativecommons.org/licenses/by/3.0/at/deed.de)

Copy link
Copy Markdown
Member

@nvkelso nvkelso Jul 28, 2017

Choose a reason for hiding this comment

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

  • data.gv.at needs attribution statement.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I couldn't find one on their website… I'll look a bit more.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I don't see a specific statement they require as attribution. The (English translation of the) license says:

You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

All the other "attribution statements" in this document are verbatim from the license or metadata, so it's odd to generate one ourselves and include it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Our job is to make sense of the non-sense ;) I recommend:

Attribution statement:

© offene Daten Österreichs – Digitales Geländemodell (DGM) Österreich.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Fixed in a02e0ed.

Comment thread docs/data-sources.md Outdated

These source images are composited to form tiles that make up the Mapzen Terrain Tiles service. To determine exactly which images contributed to Mapzen Terrain Tiles in a particular area, you can download the footprints database and use it with a GIS program like [QGIS](http://www.qgis.org/) to inspect which of these sources were used.

* [GeoJSON](https://example.com) (5.3MB, gzipped)
Copy link
Copy Markdown
Member

@nvkelso nvkelso Jul 28, 2017

Choose a reason for hiding this comment

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

  • These need real URLs.

Comment thread docs/attribution.md Outdated
More details can be found on the ETOPO1 [about](https://www.ngdc.noaa.gov/mgg/global/global.html) page and [data sources](https://www.ngdc.noaa.gov/mgg/global/etopo1sources.html) page, and [description](https://www.ngdc.noaa.gov/docucomp/page?xml=NOAA/NESDIS/NGDC/MGG/DEM/iso/xml/316.xml&view=getDataView&header=none) page and [disclaimer](https://www.ngdc.noaa.gov/ngdcinfo/privacy.html#disclaimer) page.
### data.gov.uk LIDAR Composite Digital Terrain Model

[Released](https://data.gov.uk/dataset/lidar-composite-dtm-2m1) by [data.gov.uk](https://data.gov.uk/), licensed under [Open Government License version 3](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

licensed under the United Kingdom [Open...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/attribution.md Outdated

### data.gv.at Digitales Geländemodell (DGM) Österreich

[Released](https://www.data.gv.at/katalog/dataset/b5de6975-417b-4320-afdb-eb2a9e2a1dbf) by [data.gv.at](https://www.data.gv.at/), licensed under [Creative Commons Namensnennung 3.0 Österreich](https://creativecommons.org/licenses/by/3.0/at/deed.de)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

by Austria's [data.gv...

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/attribution.md Outdated

### data.kartverket.no Digital terrengmodell

[Released](http://data.kartverket.no/download/content/digital-terrengmodell-10-m-utm-33) by Kartverket, [licensed](http://www.kartverket.no/data/lisens/) under [Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/deed.no).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

by Norway's Kartverket

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/attribution.md Outdated

### National Institute of Statistics and Geography (INEGI)

[Released]() under [INEGI's "free use of information" license](http://en.www.inegi.org.mx/inegi/terminos.html).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

  • Released is missing a link. Either add one or remove the link markdown.
  • Released under Mexico's

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/attribution.md
@@ -20,9 +20,7 @@ Attribution needs to "appear in a place that is reasonable to the medium or mean

3DEP (formerly NED) are several public domain datasets released by USGS:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Since we have multiple 3DEPs we should list those out a bit here? I'm thinking of the topobathy that is in California, for instance.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Or that could be added to the data sources page. Yeah, probably better there since it's also next to the footprints DB download.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/data-sources.md Outdated

- [3DEP](http://nationalmap.gov/elevation.html) (formerly NED) in the United States, 10 meters outside of Alaska, 3 meter in select land and territorial water areas
- [SRTM](https://lta.cr.usgs.gov/SRTM) globally except high latitudes, 30 meters in land areas
- [ArcticDEM](http://nga.maps.arcgis.com/apps/MapSeries/index.html?appid=cf2fba21df7540fb981f8836f2a97e25) strips of 5 meter mosaics across all of the land north of 60° latitude, including Alaska, Canada, Greenland, Iceland, Norway, and Russia
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Sweden is also covered by ArcticDEM?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/data-sources.md Outdated
## Data updates

Terrain tiles were built during 2016Q2 and 2016Q3 based on available sources at that time. Regular updates are not planned.
Terrain tiles version 1 was built during 2016Q2 and 2016Q3 based on available sources at that time. Version 1.1 was built during 2017Q3. Regular updates are not planned.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Version 1.1 was built during 2017Q3 and released 2017Q4.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Terrain tiles version 1 was built during 2016Q2 and released in 2016Q3.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed in 455a9c6.

Comment thread docs/use-service.md
@@ -34,6 +34,23 @@ Here's a sample tile in Normal format:
http://tile.mapzen.com/mapzen/terrain/v1/normal/11/330/790.png?api_key=your-mapzen-api-key
```
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We should add a note in the Requesting tiles section that all releases in the 1.x series are available in the v1/ file path, minor update versioning isn't available via the Mapzen API... something something.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I wonder if we should not mention 1.1 at all and instead say that we updated it rather than confuse with a minor version number?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"data pack 2017". You're probably right.

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Nov 13, 2017

Oh, we still need to update in the attribution.md:

Required attribution:

Required attribution when using Mapzen's hosted service:

And I think vector tiles has something like this to cover things that don't require attribution but we should thank anyhow (like ArcticDEM):

Optional attribution when using Mapzen's hosted service:

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Nov 13, 2017

In data-sources.md:

SRTM globally except high latitudes, 30 meters in land areas

We need to indicate this is 30 meters but 90 meter nominal quality. to also explain why the map below says so much of the world is 90 meters when it's the 30 meter SRTM data.

@iandees
Copy link
Copy Markdown
Member Author

iandees commented Nov 13, 2017

we still need to update in the attribution.md

What should be updated? Is this supposed to include all the attribution statements from the CC-BY sources? What is different about this listing than the "when using Mapzen hosted service" other than including Mapzen?

@iandees
Copy link
Copy Markdown
Member Author

iandees commented Nov 13, 2017

We need to indicate this is 30 meters but 90 meter nominal quality

Fixed in b6d1081.

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Nov 14, 2017

Regarding #151 (comment), the reference docs are:

***Required attribution:***

> © OpenStreetMap contributors, Who's On First

***Required attribution for Mapzen's hosted service:***

> Mapzen, © OpenStreetMap contributors, Who's On First

***Optional full attribution including all data projects:***

> Mapzen, © OpenStreetMap contributors, Who's On First, Natural Earth, and openstreetmapdata.com

@nvkelso
Copy link
Copy Markdown
Member

nvkelso commented Nov 14, 2017

Added * to 90m legend item in footprints preview image in 992c877. Ties in with Ian's earlier edit in b6d1081.

Copy link
Copy Markdown
Member

@nvkelso nvkelso left a comment

Choose a reason for hiding this comment

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

This is ready to merge. We can take care of the final 2 tasks once it's in master in the docs generator PR.

@nvkelso nvkelso merged commit 121b592 into master Nov 14, 2017
@nvkelso nvkelso deleted the iandees/v2-docs branch November 14, 2017 19:26
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.

[docs] Add info about tile coordinates

3 participants