Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes to quickstart suggested by Prem #480

Merged
merged 79 commits into from
Aug 21, 2024
Merged
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
6af1ba7
integrate custom docs with new UI
kmoscoe Jul 11, 2024
cd0fe76
more edits
kmoscoe Jul 11, 2024
c45d61b
use website wording for intro
kmoscoe Jul 15, 2024
f5cbbca
fix numbering in table
kmoscoe Jul 15, 2024
90c57e7
Merge branch 'master' into custom_dc
kmoscoe Jul 15, 2024
57ca62f
rename and some edits
kmoscoe Jul 15, 2024
2277cb1
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
kmoscoe Jul 15, 2024
fb33722
rename manage_repo file, per Bo
kmoscoe Jul 16, 2024
0ebdd67
Merge.
kmoscoe Jul 17, 2024
e3148c4
merge
kmoscoe Jul 17, 2024
ee5f580
Merge branch 'datacommonsorg:master' into master
kmoscoe Jul 22, 2024
5993fb7
Merge branch 'master' of https://github.com/datacommonsorg/docsite
kmoscoe Jul 22, 2024
61ce06d
Merge branch 'custom_dc'
kmoscoe Jul 22, 2024
2b37137
Merge branch 'datacommonsorg:master' into master
kmoscoe Jul 22, 2024
37f3e87
formatting edits
kmoscoe Jul 23, 2024
d83db88
updates per Keyur's feedback
kmoscoe Jul 24, 2024
03b906f
Fix typos
kmoscoe Jul 24, 2024
03538af
fix nav order
kmoscoe Jul 24, 2024
d7fb58f
fix link to API key request form
kmoscoe Jul 24, 2024
c746a7e
update form link
kmoscoe Jul 24, 2024
d5e04af
update key request form and output dir env var
kmoscoe Jul 24, 2024
0183130
Merge branch 'master' into custom_dc
kmoscoe Jul 25, 2024
b6f53cf
Revert to gerund
kmoscoe Jul 26, 2024
e538860
Merge branch 'master' into master
kmoscoe Jul 26, 2024
d368ba4
new troubleshooting entry
kmoscoe Jul 31, 2024
db99da0
Merge branch 'datacommonsorg:master' into master
kmoscoe Jul 31, 2024
535962c
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
kmoscoe Jul 31, 2024
fd071e9
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
kmoscoe Jul 31, 2024
771ccca
fix typo
kmoscoe Jul 31, 2024
7f2bccf
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 1, 2024
7286ff2
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
kmoscoe Aug 5, 2024
6e61dac
new data container procedures
kmoscoe Aug 5, 2024
24ea3c4
more work
kmoscoe Aug 5, 2024
03b9786
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 6, 2024
534461b
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
kmoscoe Aug 6, 2024
d4d81c8
more work
kmoscoe Aug 6, 2024
5d52e4b
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 6, 2024
8054ac7
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
kmoscoe Aug 6, 2024
166e7e1
complete data draft
kmoscoe Aug 6, 2024
079fe62
more changes
kmoscoe Aug 7, 2024
5ccaba5
more changes
kmoscoe Aug 8, 2024
6d80bcc
more revisions
kmoscoe Aug 8, 2024
21917fa
update troubleshooting doc etc.
kmoscoe Aug 9, 2024
586973a
new version of diagrams
kmoscoe Aug 12, 2024
c207f6b
remove data loading problems troubleshooting entry; can't reproduce
kmoscoe Aug 12, 2024
6fa91d3
revert title change
kmoscoe Aug 12, 2024
9cde771
add example for not mixing entity types
kmoscoe Aug 12, 2024
83bbaf2
changes from Keyur
kmoscoe Aug 12, 2024
86800ba
add screenshots for GCP, and related changes
kmoscoe Aug 13, 2024
1a23559
fixed one image
kmoscoe Aug 13, 2024
b4e6bd4
added screenshots for Cloud Run service
kmoscoe Aug 13, 2024
a68f8b4
resize images
kmoscoe Aug 13, 2024
05b1894
more changes from Keyur
kmoscoe Aug 13, 2024
c606037
fix a tiny error
kmoscoe Aug 13, 2024
9bb0355
delete unused images
kmoscoe Aug 13, 2024
c497e03
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 13, 2024
914bc76
Merge branch 'datacommonsorg:master' into custom_dc
kmoscoe Aug 13, 2024
75e9b41
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 13, 2024
edcb5bc
fix missing dash
kmoscoe Aug 13, 2024
e8ca73e
update services container name
kmoscoe Aug 14, 2024
cab4484
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 14, 2024
529b734
Merge branch 'master' into custom_dc
kmoscoe Aug 14, 2024
740a1e6
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
kmoscoe Aug 14, 2024
9bf96d7
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
kmoscoe Aug 14, 2024
ae46ea2
update build file
kmoscoe Aug 14, 2024
4ce0fb9
adjust build command
kmoscoe Aug 14, 2024
68a3f51
Revert "adjust build command"
kmoscoe Aug 14, 2024
d8f1ab7
update docker file
kmoscoe Aug 14, 2024
d67d280
more fixes
kmoscoe Aug 14, 2024
15a0a18
one last fix
kmoscoe Aug 14, 2024
5547194
Merge branch 'datacommonsorg:master' into master
kmoscoe Aug 15, 2024
0f3a1df
Merge branch 'datacommonsorg:master' into custom_dc
kmoscoe Aug 15, 2024
8c79911
merge
kmoscoe Aug 15, 2024
437948c
make links to Cloud Console open in a new page
kmoscoe Aug 15, 2024
f225640
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
kmoscoe Aug 15, 2024
1b3fcdf
fixes to quickstart suggested by Prem
kmoscoe Aug 16, 2024
4677644
one more change
kmoscoe Aug 16, 2024
ce66faf
Merge branch 'datacommonsorg:master' into custom_dc
kmoscoe Aug 16, 2024
27f8528
Merge branch 'master' into custom_dc
kmoscoe Aug 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
kmoscoe marked this conversation as resolved.
Show resolved Hide resolved
- 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.)
kmoscoe marked this conversation as resolved.
Show resolved Hide resolved
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