Update custom DC docs for single env.list file #456
Conversation
custom_dc/custom_data.md
Outdated
| @@ -242,22 +242,24 @@ The `sources` section is optional. It encodes the sources and provenances associ | |||
|
|
|||
| To load custom data uploaded to Google Cloud, see instead [Pointing the local Data Commons site to the Cloud data](/custom_dc/data_cloud.html) for procedures. | |||
|
|
|||
| ### Configure custom directories | |||
|
|
|||
| If you are using a directory other than `custom_dc/sample` to store your CSV files, edit the `env.list` file as follows: | |||
There was a problem hiding this comment.
They would need to update the file for the sample as well.
There was a problem hiding this comment.
Oops, thanks for catching.
custom_dc/custom_data.md
Outdated
| @@ -277,7 +279,7 @@ If you need to troubleshoot custom data, it is helpful to inspect the contents o | |||
| To do so, from a terminal window, open the database: | |||
|
|
|||
| <pre> | |||
| sqlite3 website/custom_dc/<var>CUSTOM_DATA_DIRECTORY</var>/datacommons/datacommons.db | |||
| sqlite3 <var>WEBSITE_ROOT</var>/<var>OUTPUT_DIRECTORY</var>/datacommons/datacommons.db | |||
There was a problem hiding this comment.
The output directory need not be under the website root. So the path can just be <var>OUTPUT_DIRECTORY</var>/datacommons/datacommons.db
| @@ -57,22 +58,22 @@ While you are testing, you can start with a single Google Cloud region; to be cl | |||
| 1. For the **Location type**, choose the same regional options as for Cloud SQL above. | |||
| 1. When you have finished setting all the configuration options, click **Create**. | |||
| 1. In the **Bucket Details** page, click **Create Folder** to create a new folder to hold your data. | |||
| 1. Name the folder as desired. Record the folder path as <code>gs://<var>BUCKET_NAME</var>/<var>FOLDER_PATH</var></code> for setting environment variables below. You can start with the sample data provided under `custom_dc/sample` and update to your own data later. | |||
| 1. Name the folder as desired. Record the folder path as <code>gs://<var>BUCKET_NAME</var>/<var>FOLDER_PATH</var></code> for setting the `OUTPUT_DIR` environment variable below. | |||
There was a problem hiding this comment.
Should we mention the deprecated GCS_DATA_PATH variable for the benefit of partners using it right now?
There was a problem hiding this comment.
No, it's in mentioned in the file.
custom_dc/data_cloud.md
Outdated
| docker run -it \ | ||
| --env-file $PWD/custom_dc/cloudsql_env.list \ | ||
| --env-file $PWD/custom_dc/env.list \ | ||
| -v <var>OUTPUT_DIRECTORY</var>:/<var>OUTPUT_DIRECTORY</var> \ |
There was a problem hiding this comment.
For GCS paths, there is nothing to mount. So you can remove this.
custom_dc/quickstart.md
Outdated
| --env-file $PWD/custom_dc/sqlite_env.list \ | ||
| -v $PWD/custom_dc/sample:/userdata \ | ||
| --env-file $PWD/custom_dc/env.list \ | ||
| -v $PWD/custom_dc/sample:/$PWD/custom_dc/sample \ |
There was a problem hiding this comment.
Remove the slash after the colon.
Can you go through all docker run commands in the doc to make sure both sides of the colon are the same exact paths?
| ### Configure custom directories | ||
|
|
||
| Edit the `env.list` file as follows: | ||
| - Set the `OUTPUT_DIR` variable to the directory where your input files are stored. The load step will create a `datacommons` subdirectory under this directory. |
There was a problem hiding this comment.
Consider adding a short note to explain this dichotomy. Something along the lines of a separate utility for managing data coming soon where input and output dirs can be different.
There was a problem hiding this comment.
Nah, let's not bother. Too much to explain now.
No description provided.