Skip to content

Commit

Permalink
Merge pull request #1321 from CartoDB/guides/copy-edits
Browse files Browse the repository at this point in the history
Guides/copy edits
  • Loading branch information
elenatorro committed Dec 10, 2019
2 parents c3659bf + 7c25fe4 commit 0f554a7
Show file tree
Hide file tree
Showing 27 changed files with 265 additions and 207 deletions.
30 changes: 15 additions & 15 deletions docs/developer-center/examples/examples.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@
"categories": [{
"title": "Data Workflows",
"samples": [{
"title": "Create CartoDataFrame from CSV",
"title": "CartoDataFrame from CSV",
"desc": "Create a CartoDataFrame from a CSV file",
"file": "create_cdf_from_csv",
"path": "data_workflows"
}, {
"title": "Create CartoDataFrame from JSON",
"title": "CartoDataFrame from JSON",
"desc": "Create a CartoDataFrame from a JSON file",
"file": "create_cdf_from_json",
"path": "data_workflows"
}, {
"title": "Create CartoDataFrame from GeoJSON",
"title": "CartoDataFrame from GeoJSON",
"desc": "Create a CartoDataFrame from a GeoJSON file",
"file": "create_cdf_from_geojson",
"path": "data_workflows"
}, {
"title": "Create CartoDataFrame from Table name",
"title": "CartoDataFrame from Table Name",
"desc": "Create a CartoDataFrame from a table name",
"file": "create_cdf_from_table",
"path": "data_workflows"
}, {
"title": "Create CartoDataFrame from SQL query",
"title": "CartoDataFrame from SQL Query",
"desc": "Create a CartoDataFrame from a SQL query",
"file": "create_cdf_from_query",
"path": "data_workflows"
Expand All @@ -35,31 +35,31 @@
"file": "upload_cdf_to_carto",
"path": "data_workflows"
}, {
"title": "Change Dataset Privacy",
"desc": "Change dataset privacy",
"title": "Change Table Privacy",
"desc": "Change table privacy",
"file": "change_dataset_privacy",
"path": "data_workflows"
}]
}, {
"title": "Data Enrichment",
"samples": [{
"title": "Points Enrichment - Public Dataset",
"desc": "Points Enrichment - Public Dataset",
"title": "Enrich Points - Public Dataset",
"desc": "Enrich Points - Public Dataset",
"file": "points_enrichment_public_dataset",
"path": "data_enrichment"
}, {
"title": "Polygons Enrichment - Public Dataset",
"desc": "Polygons Enrichment - Public Dataset",
"title": "Enrich Polygons - Public Dataset",
"desc": "Enrich Polygons - Public Dataset",
"file": "polygons_enrichment_public_dataset",
"path": "data_enrichment"
}, {
"title": "Points Enrichment - Private Dataset",
"desc": "Points Enrichment - Private Dataset",
"title": "Enrich Points - Private Dataset",
"desc": "Enrich Points - Private Dataset",
"file": "points_enrichment_private_dataset",
"path": "data_enrichment"
}, {
"title": "Polygons Enrichment - Private Dataset",
"desc": "Polygons Enrichment - Private Dataset",
"title": "Enrich Polygons - Private Dataset",
"desc": "Enrich Polygons - Private Dataset",
"file": "polygons_enrichment_private_dataset",
"path": "data_enrichment"
}, {
Expand Down
10 changes: 5 additions & 5 deletions docs/developer-center/guides/01-Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Use these guides to learn about integrating CARTOframes into your data science workflows. Working inside of a Jupyter Notebook, the guides walk through installation, visualization, authentication, data enrichment and location data services.

If you're already familiar with Jupyter Notebooks, you can also take a look to our [Notebook Examples](/developers/cartoframes/examples) for more detailed use cases.
If you are already familiar with Jupyter Notebooks, you can take a look at our [Notebook Examples](/developers/cartoframes/examples) for more detailed use cases.

### Content

Expand Down Expand Up @@ -41,16 +41,16 @@ If you're already familiar with Jupyter Notebooks, you can also take a look to o
<div class="doc-guides__cartoframes-row">
<div class="doc-guides__cartoframes-block">
<span class="doc-guides__title">
<a href="/developers/cartoframes/guides/Data-discovery/">Data discovery</a>
<a href="/developers/cartoframes/guides/Data-discovery/">Data Discovery</a>
</span>
<p class="doc-guides__description">Discover the spatial data you need searching the data catalog</p>
<p class="doc-guides__description">Discover the spatial data you need by searching the data catalog</p>
</div>

<div class="doc-guides__cartoframes-block">
<span class="doc-guides__title">
<a href="/developers/cartoframes/guides/Data-enrichment/">Data enrichment</a>
<a href="/developers/cartoframes/guides/Data-enrichment/">Data Enrichment</a>
</span>
<p class="doc-guides__description">Enrich your data with data from the data catalog</p>
<p class="doc-guides__description">Enrich your data with data from the Data Observatory</p>
</div>
</div>

Expand Down
10 changes: 6 additions & 4 deletions docs/developer-center/guides/02-Installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Installation

This guide is intended for those who are going to start using CARTOframes and gives some instructions to install CARTOframes **locally**, in a **Jupyter Notebook** and using a **Virtual Environment**.
This guide is intended for those who are using CARTOframes for the first time and provides the steps to install it **locally**, in a **Jupyter Notebook**, or using a **Virtual Environment**.

### Install CARTOframes using `pip`

It is possible to install CARTOframes with [`pip`](https://pypi.org/project/pip/) by simply typing one of the following commands to do a system install:
CARTOframes can be installed with [`pip`](https://pypi.org/project/pip/) by simply typing one of the following commands to do a system install:

To install the latest beta release (recommended), use the `--pre` flag:

Expand All @@ -27,15 +27,17 @@ $ pip install cartoframes==1.0b6

### Install CARTOframes in a Jupyter Notebook

In this documentation, all the examples are in a [Jupyter Notebook](https://jupyter.org/). It is recommended to read the [beginner documentation](https://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html) to get familiar with Jupyter. To install through a Jupyter Notebook, run this command:
In the CARTOframes Developer Center, all of the examples are in a [Jupyter Notebook](https://jupyter.org/). If you aren't familiar with Jupyter Notebooks, we recommended reading the [beginner documentation](https://jupyter-notebook-beginner-guide.readthedocs.io/en/latest/what_is_jupyter.html) to get familiar with the environment.

To install CARTOframes through a Jupyter Notebook, run this command:

```bash
! pip install cartoframes
```

### Use a Virtual Environment

It is recommended to install CARTOframes in a [Virtual Environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/), since they are very useful when working with Python locally. This section provides the necessary information to create a simple Virtual Environment and install CARTOframes in there:
We recommend installing CARTOframes in a [Virtual Environment](http://docs.python-guide.org/en/latest/dev/virtualenvs/), since they are very useful when working with Python locally. This section provides the necessary information to create a simple Virtual Environment and install CARTOframes inside of it:

```bash
$ virtualenv cartoframes_env
Expand Down
16 changes: 8 additions & 8 deletions docs/developer-center/guides/03-Authentication.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
## Authentication

### Introduction
In this guide, our purpose is to focus on the basics of authentication in CARTOframes.
This guide focuses on the basics of authentication in CARTOframes.

> To visualize your local data with CARTOframes, you don't need to be authenticated.
Authentication is needed to set up your credentials to save your data and visualizations to CARTO or to use the Location Data Services or the Data Observatory. In these cases, it's required to have a [CARTO account](https://carto.com/signup/).
Authentication is needed to set up your credentials to save your data and visualizations to CARTO, to use [Location Data Services](/developers/cartoframes/guides/Location-Data-Services/), or the [Data Observatory](developers/cartoframes/guides/Data-discovery/). Since a CARTO account is required for these cases, if you don't already have an account, you can [create one here](https://carto.com/signup/).

### Get your Master API Key
Once you have created an account, you need to get you **Master** API Key. The API keys page can be accesed from your dashboard. Once there, click on your avatar to open the dashboard menu. The API keys link will be shown.
Once you have created an account, you need to get your **Master** API Key. The API keys page can be accessed from your [CARTO Dashboard](https://carto.com/help/tutorials/your-dashboard-overview/). Once there, click on your avatar to open the dashboard menu. The API keys link will be shown.

![API Keys link - CARTO Dashboard](../../img/guides/credentials/dashboard.png)

Now that you are at your API Keys page, copy the **Master** API Key to use in the next section.
From here, copy the **Master** API Key to use in the next section.

![Master API Key - CARTO Dashboard](../../img/guides/credentials/api-keys.png)

### Setting default Credentials
### Setting default credentials

With [set_default_credentials](/developers/cartoframes/reference/#cartoframes-auth-set_default_credentials), the same user's authentication will be used by every CARTOframes component. There are different ways to set them but we encourage you to use the one that reads the credentials from a JSON file.
With [set_default_credentials](/developers/cartoframes/reference/#cartoframes-auth-set_default_credentials), the same user's authentication will be used by every CARTOframes component. There are different ways to set them but we encourage you to use the one that reads the credentials from a JSON file:

```py
from cartoframes.auth import set_default_credentials
Expand All @@ -39,7 +39,7 @@ Example `creds.json` file:

- `username`: your CARTO account username
- `api_key`: API Key of user's CARTO account. If the data to be accessed is **public**, it can be set to `default_public`.
- `base_url`: only needed for on premise or custom installations. It is usually of the form `https://username.carto.com/` for user `username`. On premises installation (and others) have a different URL pattern.
- `base_url`: only needed for on-premise or custom installations. Typically in the form of `https://username.carto.com/` for user `username`. On-premises installation (and others) have a different URL pattern.

### Conclusion
You have learnt how to authenticate to CARTO reading your credentials from a file. [Check the reference](/developers/cartoframes/reference/#heading-Auth) to learn more about how to manage your credentials.
In this guide you learned how to authenticate to CARTO reading your credentials from a file. [Check the reference](/developers/cartoframes/reference/#heading-Auth) to learn more about credentials and how to manage them.

0 comments on commit 0f554a7

Please sign in to comment.