From d17f64b077e8352d3b2d16d08f016187f67ae907 Mon Sep 17 00:00:00 2001 From: Harshal Sheth Date: Mon, 19 Aug 2024 14:38:18 -0400 Subject: [PATCH] docs(ingest): update config docs on platform instances --- metadata-ingestion/src/datahub/configuration/source_common.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/metadata-ingestion/src/datahub/configuration/source_common.py b/metadata-ingestion/src/datahub/configuration/source_common.py index 6a663a790c6c2b..7160aa6fc339d3 100644 --- a/metadata-ingestion/src/datahub/configuration/source_common.py +++ b/metadata-ingestion/src/datahub/configuration/source_common.py @@ -21,7 +21,9 @@ class PlatformInstanceConfigMixin(ConfigModel): platform_instance: Optional[str] = Field( default=None, - description="The instance of the platform that all assets produced by this recipe belong to", + description="The instance of the platform that all assets produced by this recipe belong to. " + "This should be unique within the platform. " + "See https://datahubproject.io/docs/platform-instances/ for more details.", )