diff --git a/docs/api/tutorials/lineage.md b/docs/api/tutorials/lineage.md index daa8f548b2360f..2aa3785cdf0ff1 100644 --- a/docs/api/tutorials/lineage.md +++ b/docs/api/tutorials/lineage.md @@ -131,6 +131,15 @@ You can now see the lineage between `fct_users_deleted` and `logging_events`. +### Troubleshooting Column Description Propagation + +To troubleshoot column description propagation issues, follow these steps: + +- **Verifying Propagation Settings**: Ensure column-level documentation propagation is enabled in the DataHub settings. +- **Checking Lineage Configuration**: Verify that the lineage between columns is correctly configured in the DataHub UI and through code review. +- **Reviewing Ingestion Logs**: Access and interpret ingestion logs from GMS, ingestion services, and the frontend UI for any errors or warnings. +- **Manual Verification of Column Descriptions**: Manually check that column descriptions are correctly set in the source dataset and verify their presence in the DataHub UI. + ### Expected Outcome 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. diff --git a/docs/automations/docs-propagation.md b/docs/automations/docs-propagation.md index e8eba08d3640e8..a51c752ef64f78 100644 --- a/docs/automations/docs-propagation.md +++ b/docs/automations/docs-propagation.md @@ -116,6 +116,17 @@ and then click "Rollback". This one-time step will remove all propagated tags and glossary terms from Snowflake. To simply stop propagating new tags, you can disable the automation. +## Troubleshooting Column Description Propagation + +To enhance user support for troubleshooting column description propagation issues in DataHub, follow these common troubleshooting steps: + +- **Verifying Propagation Settings**: Ensure that column-level documentation propagation is enabled in the DataHub settings. +- **Checking Lineage Configuration**: Verify that the lineage between columns is correctly configured. Use the DataHub UI to visually confirm the lineage and review the code to ensure correct lineage setup. +- **Reviewing Ingestion Logs**: Access and interpret ingestion logs from various components such as GMS, ingestion services, and the frontend UI to identify any errors or warnings. +- **Manual Verification of Column Descriptions**: Manually verify that column descriptions are correctly set in the source dataset and check their presence in the DataHub UI. + +Including examples and command snippets for each step will further assist users in diagnosing and resolving propagation issues effectively. + ## Viewing Propagated Descriptions Once the automation is enabled, you'll be able to recognize propagated descriptions as those with the thunderbolt icon next to them: