From 5913a734cb7f02b6a31f0d03126803bb54e934f7 Mon Sep 17 00:00:00 2001 From: kmoscoe <165203920+kmoscoe@users.noreply.github.com> Date: Fri, 27 Sep 2024 16:09:25 -0400 Subject: [PATCH] Add both data directories to docker run commands (#518) * 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 4ce0fb9de27f14a1d1ef28092f110974620215c5. * 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 * change from Keyur * revise procedure * merge * add brief explanation of data model to quickstart * slight wording tweak * incorporate feedback from Keyur * remove erroneous edit * correct missing text * more work on tasks for finding stuff * merge * update to use env.sample * typo * typo * get file back in head shape * fix file name * add more detail about data security * fix typo * corrections from Keyur * fix other mention of SQL queries * add both data directories to docker run commands --- custom_dc/build_image.md | 3 ++- custom_dc/custom_data.md | 2 ++ custom_dc/data_cloud.md | 2 ++ 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/custom_dc/build_image.md b/custom_dc/build_image.md index d46e141eb..df3fec9dd 100644 --- a/custom_dc/build_image.md +++ b/custom_dc/build_image.md @@ -35,7 +35,8 @@ If you want to pick up the latest prebuilt version, do the following: -p 8080:8080 \ -e DEBUG=true \ --env-file $PWD/custom_dc/env.list \ - -v $PWD/custom_dc/sample:$PWD/custom_dc/sample \ + -v INPUT_DIRECTORY:INPUT_DIRECTORY \ + -v OUTPUT_DIRECTORY:OUTPUT_DIRECTORY \ gcr.io/datcom-ci/datacommons-services:latest ``` diff --git a/custom_dc/custom_data.md b/custom_dc/custom_data.md index b42e3e6f2..1aae67ef1 100644 --- a/custom_dc/custom_data.md +++ b/custom_dc/custom_data.md @@ -263,6 +263,7 @@ In one terminal window, from the root directory, run the following command to st docker run \ --env-file $PWD/custom_dc/env.list \ \ -v INPUT_DIRECTORY:INPUT_DIRECTORY \ +-v OUTPUT_DIRECTORY:OUTPUT_DIRECTORY \ gcr.io/datcom-ci/datacommons-data:stable @@ -273,6 +274,7 @@ docker run -it \ -p 8080:8080 \ -e DEBUG=true \ --env-file $PWD/custom_dc/env.list \ +-v INPUT_DIRECTORY:INPUT_DIRECTORY \ -v OUTPUT_DIRECTORY:OUTPUT_DIRECTORY \ gcr.io/datcom-ci/datacommons-services:stable diff --git a/custom_dc/data_cloud.md b/custom_dc/data_cloud.md index 9614b21a6..824fbdb3b 100644 --- a/custom_dc/data_cloud.md +++ b/custom_dc/data_cloud.md @@ -189,6 +189,7 @@ From your project root directory, run: docker run \ --env-file $PWD/custom_dc/env.list \ -v INPUT_DIRECTORY:INPUT_DIRECTORY \ +-v OUTPUT_DIRECTORY:OUTPUT_DIRECTORY \ -e GOOGLE_APPLICATION_CREDENTIALS=/gcp/creds.json \ -v $HOME/.config/gcloud/application_default_credentials.json:/gcp/creds.json:ro \ gcr.io/datcom-ci/datacommons-data:VERSION @@ -221,6 +222,7 @@ docker run -it \ -e DEBUG=true \ -e GOOGLE_APPLICATION_CREDENTIALS=/gcp/creds.json \ -v $HOME/.config/gcloud/application_default_credentials.json:/gcp/creds.json:ro \ +-v INPUT_DIRECTORY:INPUT_DIRECTORY \ -v OUTPUT_DIRECTORY:OUTPUT_DIRECTORY \ [-v $PWD/server/templates/custom_dc/custom:/workspace/server/templates/custom_dc/custom \] [-v $PWD/static/custom_dc/custom:/workspace/static/custom_dc/custom \]