From 70e027bfd017b46e6c02eb800793fc7c15ee1aa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rom=C3=A1n=20Jim=C3=A9nez?= Date: Tue, 11 Sep 2018 18:46:02 +0200 Subject: [PATCH 1/3] Fix broken link in docs I've been looking into the docs & noticed a broken link. BTW what's the deal with having this stuff on master and not on develop? It looks like the branches have diverged --- docs/guides/01-overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/01-overview.md b/docs/guides/01-overview.md index a30d871..e6c406a 100644 --- a/docs/guides/01-overview.md +++ b/docs/guides/01-overview.md @@ -85,4 +85,4 @@ Many geometries come with various degrees of water accuracy (how closely they fo **Note:** While high clip water levels may be better for some kinds of maps and analysis, this type of data consumes more account storage space and may be subject to quota limitations. -For details about how to access any of this data, see [Accessing the Data Observatory]({{ site.dataobservatory_docs }}/guides/accesssing-the-data-observatory/). +For details about how to access any of this data, see [Accessing the Data Observatory]({{ site.dataobservatory_docs }}/guides/accessing-the-data-observatory/). From 7dd14ba29b2ea8b214279756c68e5c10afbf6854 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Arroyo=20Torrens?= Date: Mon, 29 Jun 2020 20:34:40 +0200 Subject: [PATCH 2/3] Add v1/v2 docs --- docs/{ => v1}/examples/01-measures-functions.md | 0 docs/{ => v1}/examples/02-boundary-functions.md | 0 docs/{ => v1}/examples/03-discovery-functions.md | 0 docs/{ => v1}/examples/examples.json | 0 docs/{ => v1}/guides/01-overview.md | 0 .../guides/02-accessing-the-data-observatory.md | 0 docs/{ => v1}/guides/03-glossary.md | 0 docs/{ => v1}/img/avatar_do.gif | Bin docs/{ => v1}/img/local_male_pop.jpg | Bin docs/{ => v1}/img/obs_getboundary.jpg | Bin docs/{ => v1}/img/visualize_obs_data.jpg | Bin docs/{ => v1}/reference/01-introduction.md | 0 docs/{ => v1}/reference/02-authentication.md | 0 docs/{ => v1}/reference/03-versioning.md | 0 docs/{ => v1}/reference/04-measures-functions.md | 0 docs/{ => v1}/reference/05-boundary-functions.md | 0 docs/{ => v1}/reference/06-discovery-functions.md | 0 docs/{ => v1}/support/01-support-options.md | 0 docs/{ => v1}/support/02-contribute.md | 0 docs/{ => v1}/support/03-license.md | 0 docs/v2/guides/01-overview.md | 8 ++++++++ docs/v2/reference/01-introduction.md | 5 +++++ 22 files changed, 13 insertions(+) rename docs/{ => v1}/examples/01-measures-functions.md (100%) rename docs/{ => v1}/examples/02-boundary-functions.md (100%) rename docs/{ => v1}/examples/03-discovery-functions.md (100%) rename docs/{ => v1}/examples/examples.json (100%) rename docs/{ => v1}/guides/01-overview.md (100%) rename docs/{ => v1}/guides/02-accessing-the-data-observatory.md (100%) rename docs/{ => v1}/guides/03-glossary.md (100%) rename docs/{ => v1}/img/avatar_do.gif (100%) rename docs/{ => v1}/img/local_male_pop.jpg (100%) rename docs/{ => v1}/img/obs_getboundary.jpg (100%) rename docs/{ => v1}/img/visualize_obs_data.jpg (100%) rename docs/{ => v1}/reference/01-introduction.md (100%) rename docs/{ => v1}/reference/02-authentication.md (100%) rename docs/{ => v1}/reference/03-versioning.md (100%) rename docs/{ => v1}/reference/04-measures-functions.md (100%) rename docs/{ => v1}/reference/05-boundary-functions.md (100%) rename docs/{ => v1}/reference/06-discovery-functions.md (100%) rename docs/{ => v1}/support/01-support-options.md (100%) rename docs/{ => v1}/support/02-contribute.md (100%) rename docs/{ => v1}/support/03-license.md (100%) create mode 100644 docs/v2/guides/01-overview.md create mode 100644 docs/v2/reference/01-introduction.md diff --git a/docs/examples/01-measures-functions.md b/docs/v1/examples/01-measures-functions.md similarity index 100% rename from docs/examples/01-measures-functions.md rename to docs/v1/examples/01-measures-functions.md diff --git a/docs/examples/02-boundary-functions.md b/docs/v1/examples/02-boundary-functions.md similarity index 100% rename from docs/examples/02-boundary-functions.md rename to docs/v1/examples/02-boundary-functions.md diff --git a/docs/examples/03-discovery-functions.md b/docs/v1/examples/03-discovery-functions.md similarity index 100% rename from docs/examples/03-discovery-functions.md rename to docs/v1/examples/03-discovery-functions.md diff --git a/docs/examples/examples.json b/docs/v1/examples/examples.json similarity index 100% rename from docs/examples/examples.json rename to docs/v1/examples/examples.json diff --git a/docs/guides/01-overview.md b/docs/v1/guides/01-overview.md similarity index 100% rename from docs/guides/01-overview.md rename to docs/v1/guides/01-overview.md diff --git a/docs/guides/02-accessing-the-data-observatory.md b/docs/v1/guides/02-accessing-the-data-observatory.md similarity index 100% rename from docs/guides/02-accessing-the-data-observatory.md rename to docs/v1/guides/02-accessing-the-data-observatory.md diff --git a/docs/guides/03-glossary.md b/docs/v1/guides/03-glossary.md similarity index 100% rename from docs/guides/03-glossary.md rename to docs/v1/guides/03-glossary.md diff --git a/docs/img/avatar_do.gif b/docs/v1/img/avatar_do.gif similarity index 100% rename from docs/img/avatar_do.gif rename to docs/v1/img/avatar_do.gif diff --git a/docs/img/local_male_pop.jpg b/docs/v1/img/local_male_pop.jpg similarity index 100% rename from docs/img/local_male_pop.jpg rename to docs/v1/img/local_male_pop.jpg diff --git a/docs/img/obs_getboundary.jpg b/docs/v1/img/obs_getboundary.jpg similarity index 100% rename from docs/img/obs_getboundary.jpg rename to docs/v1/img/obs_getboundary.jpg diff --git a/docs/img/visualize_obs_data.jpg b/docs/v1/img/visualize_obs_data.jpg similarity index 100% rename from docs/img/visualize_obs_data.jpg rename to docs/v1/img/visualize_obs_data.jpg diff --git a/docs/reference/01-introduction.md b/docs/v1/reference/01-introduction.md similarity index 100% rename from docs/reference/01-introduction.md rename to docs/v1/reference/01-introduction.md diff --git a/docs/reference/02-authentication.md b/docs/v1/reference/02-authentication.md similarity index 100% rename from docs/reference/02-authentication.md rename to docs/v1/reference/02-authentication.md diff --git a/docs/reference/03-versioning.md b/docs/v1/reference/03-versioning.md similarity index 100% rename from docs/reference/03-versioning.md rename to docs/v1/reference/03-versioning.md diff --git a/docs/reference/04-measures-functions.md b/docs/v1/reference/04-measures-functions.md similarity index 100% rename from docs/reference/04-measures-functions.md rename to docs/v1/reference/04-measures-functions.md diff --git a/docs/reference/05-boundary-functions.md b/docs/v1/reference/05-boundary-functions.md similarity index 100% rename from docs/reference/05-boundary-functions.md rename to docs/v1/reference/05-boundary-functions.md diff --git a/docs/reference/06-discovery-functions.md b/docs/v1/reference/06-discovery-functions.md similarity index 100% rename from docs/reference/06-discovery-functions.md rename to docs/v1/reference/06-discovery-functions.md diff --git a/docs/support/01-support-options.md b/docs/v1/support/01-support-options.md similarity index 100% rename from docs/support/01-support-options.md rename to docs/v1/support/01-support-options.md diff --git a/docs/support/02-contribute.md b/docs/v1/support/02-contribute.md similarity index 100% rename from docs/support/02-contribute.md rename to docs/v1/support/02-contribute.md diff --git a/docs/support/03-license.md b/docs/v1/support/03-license.md similarity index 100% rename from docs/support/03-license.md rename to docs/v1/support/03-license.md diff --git a/docs/v2/guides/01-overview.md b/docs/v2/guides/01-overview.md new file mode 100644 index 0000000..66722bd --- /dev/null +++ b/docs/v2/guides/01-overview.md @@ -0,0 +1,8 @@ +## Overview + +Quick reference guides for learning how to use the Data Observatory features. + +- [Data discovery guide](https://carto.com/developers/cartoframes/guides/Data-discovery/) +- [Data enrichment guide](https://carto.com/developers/cartoframes/guides/Data-enrichment/) + +Play with [real examples](https://carto.com/developers/cartoframes/examples/#example-data-observatory). diff --git a/docs/v2/reference/01-introduction.md b/docs/v2/reference/01-introduction.md new file mode 100644 index 0000000..7510c30 --- /dev/null +++ b/docs/v2/reference/01-introduction.md @@ -0,0 +1,5 @@ +## Introduction + +Browse the interactive API documentation to search for specific Data Observatory methods, arguments, and sample code that can be used to build your applications. + +[Check the reference](https://carto.com/developers/cartoframes/reference/#heading-Data-Observatory). From f3dbccdbf35424df3cf02fdad9490768db97d51e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jes=C3=BAs=20Arroyo=20Torrens?= Date: Tue, 30 Jun 2020 05:29:13 +0200 Subject: [PATCH 3/3] Move v2 doc to root --- docs/{v2 => }/guides/01-overview.md | 0 docs/{v2 => }/reference/01-introduction.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/{v2 => }/guides/01-overview.md (100%) rename docs/{v2 => }/reference/01-introduction.md (100%) diff --git a/docs/v2/guides/01-overview.md b/docs/guides/01-overview.md similarity index 100% rename from docs/v2/guides/01-overview.md rename to docs/guides/01-overview.md diff --git a/docs/v2/reference/01-introduction.md b/docs/reference/01-introduction.md similarity index 100% rename from docs/v2/reference/01-introduction.md rename to docs/reference/01-introduction.md