Troubleshooting Column Description Propagation

docs/api/tutorials/lineage.md

@@ -135,6 +135,15 @@ You can now see the lineage between `fct_users_deleted` and `logging_events`.
 
 You can now see the column-level lineage between datasets. Note that you have to enable `Show Columns` to be able to see the column-level lineage.
 
+## Troubleshooting Column Description Propagation
+
+If column descriptions are not propagating as expected, follow these troubleshooting steps:
+
+- **Verify Propagation Settings**: Ensure that column-level propagation is enabled in DataHub settings.
+- **Check Lineage Configuration**: Confirm that the lineage between columns is correctly configured using the DataHub UI and code examples for defining `FineGrainedLineage` objects.
+- **Review Ingestion Logs**: Check ingestion logs for errors or warnings related to lineage or metadata propagation using Docker, Kubernetes, or CLI debug logs.
+- **Manual Verification**: Manually verify that the column description is set correctly by inspecting DBT artifacts, using the DataHub UI, and manually emitting metadata using the DataHub Python SDK.
+
 <p align="center">
   <img width="70%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/apis/tutorials/column-level-lineage-added.png"/>
 </p>

docs/automations/docs-propagation.md

@@ -123,6 +123,15 @@ Once the automation is enabled, you'll be able to recognize propagated descripti
 The tooltip will provide additional information, including where the description originated and any intermediate hops that were 
 used to propagate the description.
 
+## Troubleshooting Column Description Propagation
+
+If column descriptions are not propagating as expected, consider the following troubleshooting steps:
+
+- **Verify Propagation Settings**: Ensure that column-level propagation is enabled in DataHub settings.
+- **Check Lineage Configuration**: Confirm that the lineage between columns is correctly configured. Use the DataHub UI to visualize column-level lineage and ensure connections are established.
+- **Review Ingestion Logs**: Examine ingestion logs for errors or warnings related to lineage or metadata propagation. Use Docker, Kubernetes, or CLI debug logs as needed.
+- **Manual Verification**: Manually verify that the column description is set correctly by inspecting DBT artifacts, using the DataHub UI, or manually emitting metadata using the DataHub Python SDK.
+
 <p align="left">
   <img width="50%"  src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/automation/oss/docs-propagation/view-propagated-docs.png"/>
 </p>

docs/lineage/airflow.md

@@ -311,6 +311,15 @@ If you're not seeing lineage in DataHub, check the following:
 - If using the v2 plugin's automatic lineage, ensure that the `enable_extractors` config is set to true and that automatic lineage is supported for your operator.
 - If using manual lineage annotation, ensure that you're using the `datahub_airflow_plugin.entities.Dataset` or `datahub_airflow_plugin.entities.Urn` classes for your inlets and outlets.
 
+### Troubleshooting Column Description Propagation
+
+If column descriptions are not propagating as expected, consider the following steps:
+
+- **Verify Propagation Settings**: Ensure that column-level propagation is enabled in DataHub settings.
+- **Check Lineage Configuration**: Confirm that the lineage between columns is correctly configured. Use the DataHub UI to visualize column-level lineage and ensure connections are established.
+- **Review Ingestion Logs**: Check ingestion logs for errors or warnings related to lineage or metadata propagation. Use Docker, Kubernetes, or CLI debug logs as applicable.
+- **Manual Verification**: Manually verify that the column description is set correctly by inspecting DBT artifacts, using the DataHub UI, or manually emitting metadata using the DataHub Python SDK.
+
 ### Incorrect URLs
 
 If your URLs aren't being generated correctly (usually they'll start with `http://localhost:8080` instead of the correct hostname), you may need to set the webserver `base_url` config.