modified: README.md

README.md

@@ -1,25 +1,26 @@
 # nr-dap-ods
-This repository holds code and artifacts for DAP ODS
+This repository holds code and artifacts for the Data Analytics Platform (DAP).
 
-File structure
+The Operational Data Store (ODS) provides access to exact copies of data assets residing in Line of Business databases, as well as data constructs (views, materialized views); that are refreshed on pre-defined schedules (nightly by default, other schedules by exception).
 
-- DDL:	nr-dap-ods/{source system}/ddl/{application name}/{Filename = name of the table}
+## File Structure
 
-- Replication DAGs: nr-dap-ods/{source system}/af/DAG/{Filename} (only replication DAGs. controller DAGs are kept in nr-dap-dlh)
+- **DDLs:**
+  `nr-dap-ods/{domain}/ddl/{application name}/{Filename = name of the table}`
 
-- Custom replication SQL: nr-dap-ods/{source system}/af/SQL/{Filename}
+- **Custom Replication Containers:**
+  `nr-dap-ods/{source system}/replication/{Files}`
 
-- Roles:	nr-dap-ods/{source system}/Roles/{Filename}
+- **Shared Replication Containers:**
+  `nr-dap-ods/shared/{Files}`
 
-- Replication, audit, and JSON flatten container: nr-dap-ods/shared/{Files}
+- **Shared ETL Tools:**
+  `nr-dap-ods/shared/tools/{name of tool}/{Files}`
 
-- Views: nr-dap-ods/shared/views/{Files}
-
-
-##  Use of GHCR
-Container image is built automatically and pushed to the GHCR any time there is a push or PR to the **main** branch. Images are named according to the file path and tagged with the branch name. Use the image name in an Airflow DAG to create a job using the nr-permitting-pipelines container. See Airflow example here: [permitting_pipeline_ats.py](https://github.com/bcgov/nr-airflow/blob/e45c83f933d1f96e479a36a3e765dabd61e1ff2e/dags/permitting_pipeline_ats.py#L18C16-L18C58)
+##  Use of GitHub Container Registry
+Container images under the 'shared' folder are built automatically and pushed to the GHCR any time there is a push or PR to the **main** branch. Images are named according to the file path and tagged with the branch name. Use the image name in an Airflow DAG to create a job using the shared containers. See Airflow example here: [permitting_ats.py](https://github.com/bcgov/nr-airflow/blob/main/dags/permitting_ats.py)
 
 Usage example:
 ```sh
-docker pull ghcr.io/bcgov/nr-dap-ods:main
+docker pull ghcr.io/bcgov/nr-dap-ods-ora2pg:main
 ```