{"action":"created","comment":{"url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/comments/86327883","pull_request_review_id":6990548,"id":86327883,"diff_hunk":"@@ -0,0 +1,246 @@\n+# Migrate to vector tiles 1.0 from earlier releases\n+\n+If you are connecting to the Mapzen vector tile service using a URL that starts with `https://vector.mapzen.com`, you need to consider your migration path for Mapzen vector tiles 1.0 and take action.\n+\n+The 1.0 release of the Mapzen vector tiles service has some [major changes and enhancements](https://mapzen.com/blog/v1-vector-tile-service/), and Mapzen recommends all existing users of the service migrate to it. This process is not automatic, and does require you to modify your project.\n+\n+At a minimum, you need to update your code or stylesheets, such as [Tangram YAML files](https://mapzen.com/documentation/tangram/sources/), to point to the service's new URL. Any additional work to use the 1.0 release depends on how much customization and styling you are using.\n+\n+## Update the service URL\n+\n+You can determine which release of the service you are using by looking at the URL in your code. If you see `vector.mapzen.com`, you are using the deprecated tile service.\n+\n+To use vector tiles 1.0, replace your URL with the following scheme, depending on which tile format you want:\n+\n+- GeoJSON: `http://tile.mapzen.com/mapzen/vector/v1/all/{z}/{x}/{y}.json`\n+- TopoJSON: `http://tile.mapzen.com/mapzen/vector/v1/all/{z}/{x}/{y}.topojson`\n+- Mapbox Vector Tile: `http://tile.mapzen.com/mapzen/vector/v1/all/{z}/{x}/{y}.mvt`\n+\n+You need to append your own [API key](https://mapzen.com/documentation/overview/) at the end for access to the full rate limits.\n+\n+Mapzen offers several different types of tiles in vector and raster formats and the service combines data from multiple sources. Because of this, it was not possible to redirect existing queries automatically to use the 1.0 URL.\n+\n+## Choose whether to use some or all layers\n+\n+A vector tiles request can be for one or more individual layers, such as `roads` or `landuse`, or for `all` layers in the service.\n+\n+With the 1.0 release, you may find benefits to requesting `all` layers instead of custom ones. You should run benchmark tests for both custom and `all` layers on your target devices and network connections. If you find that one method is clearly faster than the other, then choose it. If the results are about the same, then use `all` because it has a simpler service architecture.\n+\n+If you choose `all`, you can use client-side cartography to limit the display of the layers. For example, if you are using Tangram to draw your map, you can use data [filters](https://mapzen.com/documentation/tangram/Filters-Overview/).\n+\n+Both custom and `all` layers are part of Mapzen's global tile server cache. This is beneficial because tiles from the cache do not count toward your rate limits and can be served faster, yet the map data in the tiles can still be updated regularly.","path":"docs/migrate-to-vector-tiles-1.0.md","position":null,"original_position":31,"commit_id":"c43fa225f3960ad131364c776201219c1572ac9f","original_commit_id":"19027164a1f274f99802e07b9cb4d137d241ec01","user":{"login":"rmarianski","id":53770,"avatar_url":"https://avatars.githubusercontent.com/u/53770?v=3","gravatar_id":"","url":"https://api.github.com/users/rmarianski","html_url":"https://github.com/rmarianski","followers_url":"https://api.github.com/users/rmarianski/followers","following_url":"https://api.github.com/users/rmarianski/following{/other_user}","gists_url":"https://api.github.com/users/rmarianski/gists{/gist_id}","starred_url":"https://api.github.com/users/rmarianski/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rmarianski/subscriptions","organizations_url":"https://api.github.com/users/rmarianski/orgs","repos_url":"https://api.github.com/users/rmarianski/repos","events_url":"https://api.github.com/users/rmarianski/events{/privacy}","received_events_url":"https://api.github.com/users/rmarianski/received_events","type":"User","site_admin":false},"body":"> @rmarianski to confirm (and make sure we're not double counting against API limits when the custom request is on-demand).\r\n\r\n:white_check_mark: That's right.\r\nSpecifically, the xonacatl request itself is not rate limited, and it's just the subrequest to the `all` layer that may require a new tile to be generated. This may change in the future if we find that xonacatl itself needs to be guarded (and here we would need to avoid double counting). Anyway, :+1: that the rate limits info has been removed, because it might just add confusion, which I probably just did.\r\n","created_at":"2016-11-03T11:58:06Z","updated_at":"2016-11-03T11:58:06Z","html_url":"https://github.com/tilezen/vector-datasource/pull/1115#discussion_r86327883","pull_request_url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115","_links":{"self":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/comments/86327883"},"html":{"href":"https://github.com/tilezen/vector-datasource/pull/1115#discussion_r86327883"},"pull_request":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115"}}},"pull_request":{"url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115","id":91898369,"html_url":"https://github.com/tilezen/vector-datasource/pull/1115","diff_url":"https://github.com/tilezen/vector-datasource/pull/1115.diff","patch_url":"https://github.com/tilezen/vector-datasource/pull/1115.patch","issue_url":"https://api.github.com/repos/tilezen/vector-datasource/issues/1115","number":1115,"state":"open","locked":false,"title":"Add \"migration to 1.0\" documentation page","user":{"login":"rmglennon","id":4380498,"avatar_url":"https://avatars.githubusercontent.com/u/4380498?v=3","gravatar_id":"","url":"https://api.github.com/users/rmglennon","html_url":"https://github.com/rmglennon","followers_url":"https://api.github.com/users/rmglennon/followers","following_url":"https://api.github.com/users/rmglennon/following{/other_user}","gists_url":"https://api.github.com/users/rmglennon/gists{/gist_id}","starred_url":"https://api.github.com/users/rmglennon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rmglennon/subscriptions","organizations_url":"https://api.github.com/users/rmglennon/orgs","repos_url":"https://api.github.com/users/rmglennon/repos","events_url":"https://api.github.com/users/rmglennon/events{/privacy}","received_events_url":"https://api.github.com/users/rmglennon/received_events","type":"User","site_admin":false},"body":"This adds a new file with migration information and best practices for users of the pre-1.0 service.\r\n\r\n- Tells people that they need to take action to use 1.0, as it is not automatic\r\n- Gives guidance on what happens if you continue using the deprecated service\r\n- Adds some info on performance of custom layers vs all from https://github.com/tilezen/vector-datasource/issues/1111 \r\n- Adds the detailed migration guide into the docs from @nvkelso's personal account gist (with a few formatting edits and changes to terms like \"funky\") into the documentation set...we will need to publish this to see what it looks like on the website.\r\n\r\nIf we can get this installed, maybe @burritojustice and @migurski can reference the link to the docs in the newsletter this week.\r\n\r\nThis is similar to the Pelias to Mapzen Search v1 document (it was in the docs on mapzen.com for about a year): https://github.com/pelias/pelias-doc/blob/master/transition-from-beta.md \r\n\r\nPlease review and add comments and commits to clarify or correct. Thanks!\r\n\r\ncc @kkowalsky ","created_at":"2016-11-02T02:17:36Z","updated_at":"2016-11-03T11:58:06Z","closed_at":null,"merged_at":null,"merge_commit_sha":"00ac81b94a3fa74e7621f1c15355b8b8e593ddb3","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115/commits","review_comments_url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115/comments","review_comment_url":"https://api.github.com/repos/tilezen/vector-datasource/pulls/comments{/number}","comments_url":"https://api.github.com/repos/tilezen/vector-datasource/issues/1115/comments","statuses_url":"https://api.github.com/repos/tilezen/vector-datasource/statuses/c43fa225f3960ad131364c776201219c1572ac9f","head":{"label":"rmglennon:rhonda-migration","ref":"rhonda-migration","sha":"c43fa225f3960ad131364c776201219c1572ac9f","user":{"login":"rmglennon","id":4380498,"avatar_url":"https://avatars.githubusercontent.com/u/4380498?v=3","gravatar_id":"","url":"https://api.github.com/users/rmglennon","html_url":"https://github.com/rmglennon","followers_url":"https://api.github.com/users/rmglennon/followers","following_url":"https://api.github.com/users/rmglennon/following{/other_user}","gists_url":"https://api.github.com/users/rmglennon/gists{/gist_id}","starred_url":"https://api.github.com/users/rmglennon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rmglennon/subscriptions","organizations_url":"https://api.github.com/users/rmglennon/orgs","repos_url":"https://api.github.com/users/rmglennon/repos","events_url":"https://api.github.com/users/rmglennon/events{/privacy}","received_events_url":"https://api.github.com/users/rmglennon/received_events","type":"User","site_admin":false},"repo":{"id":72594669,"name":"vector-datasource","full_name":"rmglennon/vector-datasource","owner":{"login":"rmglennon","id":4380498,"avatar_url":"https://avatars.githubusercontent.com/u/4380498?v=3","gravatar_id":"","url":"https://api.github.com/users/rmglennon","html_url":"https://github.com/rmglennon","followers_url":"https://api.github.com/users/rmglennon/followers","following_url":"https://api.github.com/users/rmglennon/following{/other_user}","gists_url":"https://api.github.com/users/rmglennon/gists{/gist_id}","starred_url":"https://api.github.com/users/rmglennon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rmglennon/subscriptions","organizations_url":"https://api.github.com/users/rmglennon/orgs","repos_url":"https://api.github.com/users/rmglennon/repos","events_url":"https://api.github.com/users/rmglennon/events{/privacy}","received_events_url":"https://api.github.com/users/rmglennon/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/rmglennon/vector-datasource","description":"Mapzen vector tile service - OpenStreetMap vector tiles in several formats","fork":true,"url":"https://api.github.com/repos/rmglennon/vector-datasource","forks_url":"https://api.github.com/repos/rmglennon/vector-datasource/forks","keys_url":"https://api.github.com/repos/rmglennon/vector-datasource/keys{/key_id}","collaborators_url":"https://api.github.com/repos/rmglennon/vector-datasource/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/rmglennon/vector-datasource/teams","hooks_url":"https://api.github.com/repos/rmglennon/vector-datasource/hooks","issue_events_url":"https://api.github.com/repos/rmglennon/vector-datasource/issues/events{/number}","events_url":"https://api.github.com/repos/rmglennon/vector-datasource/events","assignees_url":"https://api.github.com/repos/rmglennon/vector-datasource/assignees{/user}","branches_url":"https://api.github.com/repos/rmglennon/vector-datasource/branches{/branch}","tags_url":"https://api.github.com/repos/rmglennon/vector-datasource/tags","blobs_url":"https://api.github.com/repos/rmglennon/vector-datasource/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/rmglennon/vector-datasource/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/rmglennon/vector-datasource/git/refs{/sha}","trees_url":"https://api.github.com/repos/rmglennon/vector-datasource/git/trees{/sha}","statuses_url":"https://api.github.com/repos/rmglennon/vector-datasource/statuses/{sha}","languages_url":"https://api.github.com/repos/rmglennon/vector-datasource/languages","stargazers_url":"https://api.github.com/repos/rmglennon/vector-datasource/stargazers","contributors_url":"https://api.github.com/repos/rmglennon/vector-datasource/contributors","subscribers_url":"https://api.github.com/repos/rmglennon/vector-datasource/subscribers","subscription_url":"https://api.github.com/repos/rmglennon/vector-datasource/subscription","commits_url":"https://api.github.com/repos/rmglennon/vector-datasource/commits{/sha}","git_commits_url":"https://api.github.com/repos/rmglennon/vector-datasource/git/commits{/sha}","comments_url":"https://api.github.com/repos/rmglennon/vector-datasource/comments{/number}","issue_comment_url":"https://api.github.com/repos/rmglennon/vector-datasource/issues/comments{/number}","contents_url":"https://api.github.com/repos/rmglennon/vector-datasource/contents/{+path}","compare_url":"https://api.github.com/repos/rmglennon/vector-datasource/compare/{base}...{head}","merges_url":"https://api.github.com/repos/rmglennon/vector-datasource/merges","archive_url":"https://api.github.com/repos/rmglennon/vector-datasource/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/rmglennon/vector-datasource/downloads","issues_url":"https://api.github.com/repos/rmglennon/vector-datasource/issues{/number}","pulls_url":"https://api.github.com/repos/rmglennon/vector-datasource/pulls{/number}","milestones_url":"https://api.github.com/repos/rmglennon/vector-datasource/milestones{/number}","notifications_url":"https://api.github.com/repos/rmglennon/vector-datasource/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/rmglennon/vector-datasource/labels{/name}","releases_url":"https://api.github.com/repos/rmglennon/vector-datasource/releases{/id}","deployments_url":"https://api.github.com/repos/rmglennon/vector-datasource/deployments","created_at":"2016-11-02T02:04:40Z","updated_at":"2016-11-02T02:04:41Z","pushed_at":"2016-11-02T23:35:39Z","git_url":"git://github.com/rmglennon/vector-datasource.git","ssh_url":"git@github.com:rmglennon/vector-datasource.git","clone_url":"https://github.com/rmglennon/vector-datasource.git","svn_url":"https://github.com/rmglennon/vector-datasource","homepage":"http://mapzen.com/vector","size":64453,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"tilezen:master","ref":"master","sha":"cd216dbf245c173052a3cbe9dabd891b962cac39","user":{"login":"tilezen","id":19462720,"avatar_url":"https://avatars.githubusercontent.com/u/19462720?v=3","gravatar_id":"","url":"https://api.github.com/users/tilezen","html_url":"https://github.com/tilezen","followers_url":"https://api.github.com/users/tilezen/followers","following_url":"https://api.github.com/users/tilezen/following{/other_user}","gists_url":"https://api.github.com/users/tilezen/gists{/gist_id}","starred_url":"https://api.github.com/users/tilezen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tilezen/subscriptions","organizations_url":"https://api.github.com/users/tilezen/orgs","repos_url":"https://api.github.com/users/tilezen/repos","events_url":"https://api.github.com/users/tilezen/events{/privacy}","received_events_url":"https://api.github.com/users/tilezen/received_events","type":"Organization","site_admin":false},"repo":{"id":13446739,"name":"vector-datasource","full_name":"tilezen/vector-datasource","owner":{"login":"tilezen","id":19462720,"avatar_url":"https://avatars.githubusercontent.com/u/19462720?v=3","gravatar_id":"","url":"https://api.github.com/users/tilezen","html_url":"https://github.com/tilezen","followers_url":"https://api.github.com/users/tilezen/followers","following_url":"https://api.github.com/users/tilezen/following{/other_user}","gists_url":"https://api.github.com/users/tilezen/gists{/gist_id}","starred_url":"https://api.github.com/users/tilezen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tilezen/subscriptions","organizations_url":"https://api.github.com/users/tilezen/orgs","repos_url":"https://api.github.com/users/tilezen/repos","events_url":"https://api.github.com/users/tilezen/events{/privacy}","received_events_url":"https://api.github.com/users/tilezen/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/tilezen/vector-datasource","description":"Mapzen vector tile service - OpenStreetMap vector tiles in several formats","fork":false,"url":"https://api.github.com/repos/tilezen/vector-datasource","forks_url":"https://api.github.com/repos/tilezen/vector-datasource/forks","keys_url":"https://api.github.com/repos/tilezen/vector-datasource/keys{/key_id}","collaborators_url":"https://api.github.com/repos/tilezen/vector-datasource/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/tilezen/vector-datasource/teams","hooks_url":"https://api.github.com/repos/tilezen/vector-datasource/hooks","issue_events_url":"https://api.github.com/repos/tilezen/vector-datasource/issues/events{/number}","events_url":"https://api.github.com/repos/tilezen/vector-datasource/events","assignees_url":"https://api.github.com/repos/tilezen/vector-datasource/assignees{/user}","branches_url":"https://api.github.com/repos/tilezen/vector-datasource/branches{/branch}","tags_url":"https://api.github.com/repos/tilezen/vector-datasource/tags","blobs_url":"https://api.github.com/repos/tilezen/vector-datasource/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/tilezen/vector-datasource/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/tilezen/vector-datasource/git/refs{/sha}","trees_url":"https://api.github.com/repos/tilezen/vector-datasource/git/trees{/sha}","statuses_url":"https://api.github.com/repos/tilezen/vector-datasource/statuses/{sha}","languages_url":"https://api.github.com/repos/tilezen/vector-datasource/languages","stargazers_url":"https://api.github.com/repos/tilezen/vector-datasource/stargazers","contributors_url":"https://api.github.com/repos/tilezen/vector-datasource/contributors","subscribers_url":"https://api.github.com/repos/tilezen/vector-datasource/subscribers","subscription_url":"https://api.github.com/repos/tilezen/vector-datasource/subscription","commits_url":"https://api.github.com/repos/tilezen/vector-datasource/commits{/sha}","git_commits_url":"https://api.github.com/repos/tilezen/vector-datasource/git/commits{/sha}","comments_url":"https://api.github.com/repos/tilezen/vector-datasource/comments{/number}","issue_comment_url":"https://api.github.com/repos/tilezen/vector-datasource/issues/comments{/number}","contents_url":"https://api.github.com/repos/tilezen/vector-datasource/contents/{+path}","compare_url":"https://api.github.com/repos/tilezen/vector-datasource/compare/{base}...{head}","merges_url":"https://api.github.com/repos/tilezen/vector-datasource/merges","archive_url":"https://api.github.com/repos/tilezen/vector-datasource/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/tilezen/vector-datasource/downloads","issues_url":"https://api.github.com/repos/tilezen/vector-datasource/issues{/number}","pulls_url":"https://api.github.com/repos/tilezen/vector-datasource/pulls{/number}","milestones_url":"https://api.github.com/repos/tilezen/vector-datasource/milestones{/number}","notifications_url":"https://api.github.com/repos/tilezen/vector-datasource/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/tilezen/vector-datasource/labels{/name}","releases_url":"https://api.github.com/repos/tilezen/vector-datasource/releases{/id}","deployments_url":"https://api.github.com/repos/tilezen/vector-datasource/deployments","created_at":"2013-10-09T15:54:45Z","updated_at":"2016-10-28T14:20:03Z","pushed_at":"2016-11-02T23:35:39Z","git_url":"git://github.com/tilezen/vector-datasource.git","ssh_url":"git@github.com:tilezen/vector-datasource.git","clone_url":"https://github.com/tilezen/vector-datasource.git","svn_url":"https://github.com/tilezen/vector-datasource","homepage":"http://mapzen.com/vector","size":70094,"stargazers_count":275,"watchers_count":275,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":61,"mirror_url":null,"open_issues_count":179,"forks":61,"open_issues":179,"watchers":275,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115"},"html":{"href":"https://github.com/tilezen/vector-datasource/pull/1115"},"issue":{"href":"https://api.github.com/repos/tilezen/vector-datasource/issues/1115"},"comments":{"href":"https://api.github.com/repos/tilezen/vector-datasource/issues/1115/comments"},"review_comments":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115/comments"},"review_comment":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/tilezen/vector-datasource/pulls/1115/commits"},"statuses":{"href":"https://api.github.com/repos/tilezen/vector-datasource/statuses/c43fa225f3960ad131364c776201219c1572ac9f"}}}}
{"actor":{"display_login":"rmarianski"}}