From 2a05b86e55b2bdcca41992498c10c6d970e07402 Mon Sep 17 00:00:00 2001 From: csubira Date: Wed, 6 Mar 2019 18:15:42 +0100 Subject: [PATCH] Add CR changes and update older links in dev center docs --- docs/developer-center/guides/01-overview.md | 4 ++-- docs/developer-center/reference/05-geocoding-functions.md | 2 +- docs/developer-center/reference/06-isoline-functions.md | 2 +- .../reference/07-demographic-functions.md | 2 +- .../reference/09-segmentation-functions.md | 2 +- docs/developer-center/support/03-quota-information.md | 8 ++++---- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/developer-center/guides/01-overview.md b/docs/developer-center/guides/01-overview.md index e3c2f99..fbb1901 100644 --- a/docs/developer-center/guides/01-overview.md +++ b/docs/developer-center/guides/01-overview.md @@ -14,13 +14,13 @@ The Data Services API also exposes its services directly through CARTO Builder. The geometries provided by this API are projected in the projection [WGS 84 SRID 4326](http://spatialreference.org/ref/epsg/wgs-84/). -**Note:** The Data Services API [geocoding functions]({{site.dataservicesapi_docs}}/reference/#geocoding-functions) return different types of geometries (points or polygons) as result of different geocoding processes. The CARTO Engine does not support multi-geometry layers or datasets, therefore you must confirm that you are using consistent geometry types inside a table, to avoid future conflicts in your map visualization. +**Note:** The Data Services API [geocoding functions]({{site.dataservicesapi_docs}}/reference/#geocoding-functions) return different types of geometries (points or polygons) as result of different geocoding processes. The CARTO Engine does not support multi-geometry layers or datasets, therefore you must verify that you are using consistent geometry types inside a table, to avoid future conflicts in your map visualization. #### Best Practices _Be mindful of the following usage notes when using the Data Services functions with the SQL API:_ -It is discouraged to use the SELECT operation with the Data Services API functions in your map layers, as these type of queries consume quota when rendering tiles for your live map views. It may also result in sync performance issues, due to executing multiple requests to the API each time your map is viewed. See details about [Quota Consumption]({{site.dataservicesapi_docs}}/support/quota-information/). +It is discouraged to use the SELECT operation with the Data Services API functions in your map layers, as these type of queries consume quota when rendering tiles for your live map views. It may also result in sync performance issues, due to executing multiple requests to the API each time your map is viewed. See details about [Quota Consumption]({{site.dataservicesapi_docs}}/support/quota-information/#quota-consumption). The Data Services API is **recommended** to be used with INSERT or UPDATE operations, for applying location data to your tables. While SELECT (retrieve) is standard for SQL API requests, be mindful of quota consumption and use INSERT (to insert a new record) or UPDATE (to update an existing record), for best practices. diff --git a/docs/developer-center/reference/05-geocoding-functions.md b/docs/developer-center/reference/05-geocoding-functions.md index 6f73568..4143f7f 100644 --- a/docs/developer-center/reference/05-geocoding-functions.md +++ b/docs/developer-center/reference/05-geocoding-functions.md @@ -311,7 +311,7 @@ INSERT INTO {tablename} (the_geom) SELECT cdb_geocode_ipaddress_point('102.23.34 ### Street-Level Geocoder -This function geocodes your data into a point geometry for a street address. CARTO platform uses [Mapbox geocoding services](https://www.mapbox.com/) as the service provider for street-level geocoding. [Contact us](mailto:sales@carto.com) if you have any specific questions or requirements about the location data service provider being used with your account. +This function geocodes your data into a point geometry for a street address. CARTO platform uses [Mapbox geocoding services](https://www.mapbox.com/) by default as the service provider for street-level geocoding. [Contact us](mailto:sales@carto.com) if you have any specific questions or requirements about the location data service provider being used with your account. **This service is subject to quota limitations, and extra fees may apply**. View the [Quota information]({{site.dataservicesapi_docs}}/support/quota-information/) for details and recommendations about quota consumption. diff --git a/docs/developer-center/reference/06-isoline-functions.md b/docs/developer-center/reference/06-isoline-functions.md index 1e95eb5..d8024f8 100644 --- a/docs/developer-center/reference/06-isoline-functions.md +++ b/docs/developer-center/reference/06-isoline-functions.md @@ -2,7 +2,7 @@ [Isolines](https://carto.com/data/isolines/) are contoured lines that display equally calculated levels over a given surface area. This enables you to view polygon dimensions by forward or reverse measurements. Isoline functions are calculated as the intersection of areas from the origin point, measured by distance (isodistance) or time (isochrone). For example, the distance of a road from a sidewalk. Isoline services through CARTO are available by requesting a single function in the Data Services API. -_**This service is subject to quota limitations and extra fees may apply**. View the [Quota Information](https://carto.com/docs/carto-engine/dataservices-api/quota-information/) section for details and recommendations about to quota consumption._ +_**This service is subject to quota limitations and extra fees may apply**. View the [Quota Information]({{site.dataservicesapi_docs}}/support/quota-information/) section for details and recommendations about to quota consumption._ You can use the isoline functions to retrieve, for example, isochrone lines from a certain location, specifying the mode and the ranges that will define each of the isolines. The following query calculates isolines for areas that are 5, 10 and 15 minutes (300, 600 and 900 seconds, respectively) away from the location by following a path defined by car routing and inserts them into a table. diff --git a/docs/developer-center/reference/07-demographic-functions.md b/docs/developer-center/reference/07-demographic-functions.md index 204962e..b3564e6 100644 --- a/docs/developer-center/reference/07-demographic-functions.md +++ b/docs/developer-center/reference/07-demographic-functions.md @@ -1,6 +1,6 @@ ### Demographic Functions -The Demographic Snapshot enables you to collect demographic reports around a point location. For example, you can take the coordinates of a coffee shop and find the average population characteristics, such as total population, educational attainment, housing and income information around that location. You can use raw street addresses by combining the Demographic Snapshot with CARTO's geocoding features. If you need help creating coordinates from addresses, see the [Geocoding Functions](https://carto.com/docs/carto-engine/dataservices-api/geocoding-functions/) documentation. +The Demographic Snapshot enables you to collect demographic reports around a point location. For example, you can take the coordinates of a coffee shop and find the average population characteristics, such as total population, educational attainment, housing and income information around that location. You can use raw street addresses by combining the Demographic Snapshot with CARTO's geocoding features. If you need help creating coordinates from addresses, see the [Geocoding Functions]({{site.dataservicesapi_docs}}/reference/#geocoding-functions) documentation. _**Note:** The Demographic Snapshot functions are only available for the United States._ diff --git a/docs/developer-center/reference/09-segmentation-functions.md b/docs/developer-center/reference/09-segmentation-functions.md index bbfe913..1d69cd2 100644 --- a/docs/developer-center/reference/09-segmentation-functions.md +++ b/docs/developer-center/reference/09-segmentation-functions.md @@ -1,6 +1,6 @@ ## Segmentation Functions -The Segmentation Snapshot functions enable you to determine the pre-calculated population segment for a location. Segmentation is a method that divides a populations into subclassifications based on common traits. For example, you can take the a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions](https://carto.com/docs/carto-engine/dataservices-api/geocoding-functions/) documentation. +The Segmentation Snapshot functions enable you to determine the pre-calculated population segment for a location. Segmentation is a method that divides a populations into subclassifications based on common traits. For example, you can take the a store location and determine what classification of population exists around that location. If you need help creating coordinates from addresses, see the [Geocoding Functions]({{site.dataservicesapi_docs}}/reference/#geocoding-functions) documentation. _**Note:** The Segmentation Snapshot functions are only available for the United States. Our first release (May 18, 2016) is derived from Census 2010 variables. Our next release will be based on Census 2014 data. For the latest information, see the [Open Segments](https://github.com/CartoDB/open-segments) project repository._ diff --git a/docs/developer-center/support/03-quota-information.md b/docs/developer-center/support/03-quota-information.md index b12288c..1a50dc9 100644 --- a/docs/developer-center/support/03-quota-information.md +++ b/docs/developer-center/support/03-quota-information.md @@ -36,10 +36,10 @@ Name | Type | Description Service Types: -* `'isolines'` [Isoline/Isochrones (isochrone/isodistance lines) service](https://carto.com/docs/carto-engine/dataservices-api/isoline_functions/) -* `'hires_geocoder'` [Street level geocoding](https://carto.com/docs/carto-engine/dataservices-api/geocoding-functions#street-level-geocoder) -* `'routing'` [Routing functions](https://carto.com/docs/carto-engine/dataservices-api/routing_functions/) -* `'observatory'` Data Observatory services ([demographic](https://carto.com/docs/carto-engine/dataservices-api/demographic_functions/) and [segmentation](https://carto.com/docs/carto-engine/dataservices-api/segmentation_functions/) functions) +* `'isolines'` [Isoline/Isochrones (isochrone/isodistance lines) service]({{site.dataservicesapi_docs}}/reference/#isoline_functions/) +* `'hires_geocoder'` [Street level geocoding]({{site.dataservicesapi_docs}}/reference/#street-level-geocoder) +* `'routing'` [Routing functions]({{site.dataservicesapi_docs}}/reference/#routing_functions/) +* `'observatory'` Data Observatory services ([demographic]({{site.dataservicesapi_docs}}/reference/#demographic_functions/) and [segmentation]({{site.dataservicesapi_docs}}/reference/#segmentation_functions/) functions) **Notes**