Fix doc

databricks · Oct 19, 2023 · cfdc2ad · cfdc2ad
1 parent 8106188
commit cfdc2ad
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/...root_dir}}/{{template `project_name_alphanumeric_underscore` .}}/resources/README.md.tmpl b/...root_dir}}/{{template `project_name_alphanumeric_underscore` .}}/resources/README.md.tmpl
@@ -32,6 +32,16 @@ Deployment configs of different deployment targets share the general ML resource
 
 This project ships with CI/CD workflows for developing and deploying ML resource configurations based on deployment config.
 
+{{- if (eq .input_include_models_in_unity_catalog "yes") }}
+
+NOTE: For Model Registry in Unity Catalog, we expect a catalog to exist with the name of the deployment target by default. For example, if the deployment target is `dev`, we expect a catalog named `dev` to exist in the workspace. 
+If you want to use different catalog names, please update the `targets` declared in the `{{template `project_name_alphanumeric_underscore` .}}/databricks.yml` and `{{template `project_name_alphanumeric_underscore` .}}/resources/ml-artifacts-resource.yml` files.
+If changing the `staging`, `prod`, or `test` deployment targets, you'll need to update the 
+{{- if or (eq .input_cicd_platform `github_actions`) (eq .input_cicd_platform `github_actions_for_github_enterprise_servers`) }} workflows located in the `.github/workflows` directory.
+{{- else if (eq .input_cicd_platform `azure_devops`) }}  pipelines located in the `azure-pipelines` directory.{{- end }}
+{{- end }}
+
+
 | Deployment Target | Description                                                                                                                                                                                                                           | Databricks Workspace | Model Name                          | Experiment Name                                |
 |-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|-------------------------------------|------------------------------------------------|
 | dev         | The `dev` deployment target is used by ML engineers to deploy ML resources to development workspace with `dev` configs. The config is for ML project development purposes.                                                           | dev workspace        | dev-{{template `model_name` .}}     | /dev-{{template `experiment_base_name` .}}     |