Skip to content

Commit

Permalink
Changes to quickstart suggested by Prem (#480)
Browse files Browse the repository at this point in the history
* integrate custom docs with new UI

* more edits

* use website wording for intro

* fix numbering in table

* rename and some edits

* rename manage_repo file, per Bo

* Merge.

* formatting edits

* updates per Keyur's feedback

* Fix typos

* fix nav order

* fix link to API key request form

* update form link

* update key request form and output dir env var

* Revert to gerund

Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting"

* new troubleshooting entry

* fix typo

* new data container procedures

* more work

* more work

* complete data draft

* more changes

* more changes

* more revisions

* update troubleshooting doc etc.

* new version of diagrams

* remove data loading problems troubleshooting entry; can't reproduce

* revert title change

* add example for not mixing entity types

* changes from Keyur

* add screenshots for GCP, and related changes

* fixed one image

* added screenshots for Cloud Run service

* resize images

* more changes from Keyur

* fix a tiny error

* delete unused images

* fix missing dash

* update build file

* adjust build command

* Revert "adjust build command"

This reverts commit 4ce0fb9.

* update docker file

* more fixes

* one last fix

* make links to Cloud Console open in a new page

* fixes to quickstart suggested by Prem

* one more change
  • Loading branch information
kmoscoe authored Aug 21, 2024
1 parent c78e8ca commit c904010
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions custom_dc/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The "services" Docker container consists of the following Data Commons component

## Prerequisites

- Obtain a [GCP](https://console.cloud.google.com/welcome) billing account and project.
- Obtain a [GCP](https://cloud.google.com/docs/get-started) billing account and project.
- If you are developing on Windows, install [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install) (any distribution will do, but we recommend the default, Ubuntu), and enable [WSL 2 integration with Docker](https://docs.docker.com/desktop/wsl/).
- Install [Docker Desktop/Engine](https://docs.docker.com/engine/install/).
- Install [Git](https://git-scm.com/).
Expand All @@ -44,15 +44,15 @@ The "services" Docker container consists of the following Data Commons component

### Enable Google Cloud APIs and get a Maps API key {#maps-key}

1. Go to [https://console.cloud.google.com/apis/dashboard](https://console.cloud.google.com/apis/dashboard) for your project.
1. Go to [https://console.cloud.google.com/apis/dashboard](https://console.cloud.google.com/apis/dashboard){: target="_blank"} for your project.
1. Click **Enable APIs & Services**.
1. Under **Maps**, enable **Places API** and **Maps Javascript API**.
1. Go to [https://console.cloud.google.com/google/maps-apis/credentials](https://console.cloud.google.com/google/maps-apis/credentials) for your project.
1. Go to [https://console.cloud.google.com/google/maps-apis/credentials](https://console.cloud.google.com/google/maps-apis/credentials){: target="_blank"} for your project.
1. Click **Create Credentials** > **API Key**.
1. Record the key and click **Close**.
1. Click on the newly created key to open the **Edit API Key** window.
1. Under API restrictions, select Restrict key.
1. From the drop-down menu, enable Places API and Maps Javascript API. (Optionally enable other APIs for which you want to use this key.)
1. Under **API restrictions**, select **Restrict key**.
1. From the drop-down menu, enable **Places API** and **Maps Javascript API**. (Optionally enable other APIs for which you want to use this key.)
1. Click **OK** and **Save**.

### Clone the Data Commons repository
Expand All @@ -77,7 +77,7 @@ cd website

1. Using your favorite editor, open `custom_dc/env.list`.
1. Enter the relevant values for `DC_API_KEY` and `MAPS_API_KEY`.
1. Set the `INPUT_DIR` to the full path to the `sample/` directory. For example if you have cloned the repo directly to your home directory, this would be <code>/home/<var>USERNAME</var>/website/custom_dc/sample/</code>.
1. Set the `INPUT_DIR` to the full path to the `website/custom_dc/sample/` directory. For example if you have cloned the repo directly to your home directory, this might be <code>/home/<var>USERNAME</var>/website/custom_dc/sample/</code>. (If you're not sure, type `pwd` to get the working directory.)
1. For the `OUTPUT_DIR`, set it to the same path as the `INPUT_DIR`.

**Warning:** Do not use any quotes (single or double) or spaces when specifying the values.
Expand Down Expand Up @@ -191,7 +191,7 @@ Once the services are up and running, visit your local instance by pointing your

![screenshot_homepage](/assets/images/custom_dc/customdc_screenshot1.png){: width="900"}

Now click the **Timeline** link to visit the Timeline explorer. Try entering a country and click **Continue**. Now, in the **Select variables** tools, you'll see the new variables:
Now click the **Timeline** link to visit the Timeline explorer. Click **Start**, enter a country and click **Continue**. Now, in the **Select variables** tools, you'll see the new variables:

![screenshot_timeline](/assets/images/custom_dc/customdc_screenshot2.png){: width="900"}

Expand Down

0 comments on commit c904010

Please sign in to comment.