Add some notes based on on-call issues (#753)

* Add some notes based on on-call issues * quick fix Co-authored-by: enya-yx <enya@v-ellinlu-2.fareast.corp.microsoft.com>
feathr-ai · Oct 18, 2022 · aad580d · aad580d
1 parent 5030eee
commit aad580d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/concepts/feature-registry.md b/docs/concepts/feature-registry.md
@@ -74,6 +74,8 @@ client.register_features()
 all_features = client.list_registered_features(project_name=client.project_name)
 ```
 
+Please avoid applying a same name to different features under a certain project. Since it will be treated as updating an exsiting project which is not supported by feathr and will cause errors.
+
 ### Reuse Features from Existing Registry
 
 The feature producers can just let the feature consumers know which features exist so the feature consumers can reuse them. For feature consumers, they can reuse existing features from the registry. The whole project can be retrieved to local environment by calling this API `client.get_features_from_registry` with a project name. This encourage feature reuse across organizations. For example, end users of a feature just need to read all feature definitions from the existing projects, then use a few features from the projects and join those features with a new dataset you have.

diff --git a/docs/how-to-guides/feathr-configuration-and-env.md b/docs/how-to-guides/feathr-configuration-and-env.md
@@ -64,7 +64,7 @@ Feathr will get the configurations in the following order:
 | SPARK_CONFIG__SPARK_RESULT_OUTPUT_PARTS             | Configure number of parts for the spark output for feature generation job                                                                                                                                                                                                          | Required                                                                  |
 | SPARK_CONFIG__AZURE_SYNAPSE__DEV_URL                  | Dev URL to the synapse cluster. Usually it's something like `https://yourclustername.dev.azuresynapse.net`                                                                                                                                                                         | Required if using Azure Synapse                                           |
 | SPARK_CONFIG__AZURE_SYNAPSE__POOL_NAME                | name of the spark pool that you are going to use                                                                                                                                                                                                                                   | Required if using Azure Synapse                                           |
-| SPARK_CONFIG__AZURE_SYNAPSE__WORKSPACE_DIR            | A location that Synapse has access to. This workspace dir stores all the required configuration files and the jar resources. All the feature definitions will be uploaded here                                                                                                     | Required if using Azure Synapse                                           |
+| SPARK_CONFIG__AZURE_SYNAPSE__WORKSPACE_DIR            | A location that Synapse has access to. This workspace dir stores all the required configuration files and the jar resources. All the feature definitions will be uploaded here. Suggest to use an empty dir for a new spark job to avoid conflicts.                                                                                                     | Required if using Azure Synapse                                           |
 | SPARK_CONFIG__AZURE_SYNAPSE__EXECUTOR_SIZE            | Specifies the executor size for the Azure Synapse cluster. Currently the options are `Small`, `Medium`, `Large`.                                                                                                                                                                   | Required if using Azure Synapse                                           |
 | SPARK_CONFIG__AZURE_SYNAPSE__EXECUTOR_NUM             | Specifies the number of executors for the Azure Synapse cluster                                                                                                                                                                                                                    | Required if using Azure Synapse                                           |
 | SPARK_CONFIG__AZURE_SYNAPSE__FEATHR_RUNTIME_LOCATION  | Specifies the Feathr runtime location. Support local paths, path start with `http(s)://`, and paths start with `abfss:/`. If not set, will use the [Feathr package published in Maven](https://search.maven.org/artifact/com.linkedin.feathr/feathr_2.12).                         | Required if using Azure Synapse                                           |