Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs based on code PR #2 #7

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

runllm-pr-agent[bot]
Copy link

Changes Made

  • docs/lineage/dagster.md
    • ## Using DataHub's Dagster SensorDa... --> ## Using DataHub's Dagster SensorDa...: The updated code introduces the ability to capture asset materializations and observations, which should be reflected in the documentation to inform users of the new capabilities of the DataHub's Dagster Sensor.
    • ** | platform_instance ... --> | platform_instance ...**: The code changes introduce new configuration options such as asset_lineage_extractor and enable_asset_query_metadata_parsing. These should be documented to inform users about the new configuration capabilities.
    • ## Capturing Table LineageThere are... --> ## Capturing Table LineageThere are...: The code changes introduce a new section on extracting asset identifiers, which is crucial for establishing connections between Dagster assets and DataHub datasets. This information should be included in the documentation to guide users on how to properly name assets for lineage tracking.
  • docs/lineage/dagster.md
    • | capture_input_output | True | Whe... --> | capture_input_output | True | Whe...: The code changes introduce a new configuration option connect_ops_to_ops, which should be documented to inform users about its purpose and default value.
    • | enable_asset_query_metadata_parsi... --> | enable_asset_query_metadata_parsi...: The default value for enable_asset_query_metadata_parsing is set to True in the code changes, which should be reflected in the documentation to provide accurate information.
    • ## Capturing Table LineageThere are... --> ## Capturing Table LineageThere are...: The code changes introduce a new method for extracting lineage using SQL query parsing, which should be documented to guide users on how to implement this feature.
  • docs/lineage/dagster.md
    • ## Using Datahub's Dagster SensorDa... --> ## Using DataHub's Dagster SensorDa...: The documentation has been updated to reflect the enhanced capabilities of the DataHub's Dagster Sensor, which now includes emitting metadata for Pipelines, Tasks, and run results. The language has been improved for clarity and consistency.
    • ### Using Dagster Ins and OutWe can... --> ### Using Dagster Ins and OutWe can...: The documentation has been updated to capitalize 'Assets' and 'Ops' for consistency with the rest of the document. Additionally, minor grammatical improvements have been made for clarity.
    • ## Define your custom logic to capt... --> ### Using Custom Logic for Extracti...: The section title has been updated to 'Using Custom Logic for Extracting Lineage' to better align with the new features introduced in the code changes. The content has been slightly rephrased for clarity and consistency.
    • DataHub's Dagster integration can a... --> ### Using SQL Query Parsing to Extr...: The documentation has been updated to reflect the new feature of SQL query parsing for lineage extraction. The section title has been changed to 'Using SQL Query Parsing to Extract Lineage' to better describe the content. The example has been slightly modified for clarity, and a note about the importance of asset naming has been removed as it is now covered in the updated documentation.
  • docs/features.md
    • **## Key Features<FeatureCardSection/... --> ## Key Features- Dagster Integrat...: The code changes introduce new features and improvements to the Dagster integration with DataHub, such as enhanced asset metadata handling and lineage tracking. These updates should be reflected in the documentation to inform users about the new capabilities and improvements in the Dagster integration.
  • docs/dataproducts.md
    • ### Related Features [Domains](./d... --> ### Related Features [Domains](./d...**: The code changes introduce new features and improvements to the Dagster integration with DataHub, which are relevant to asset management. Adding a link to the Dagster Integration documentation will help users find more detailed information about these new features and how they relate to asset management in DataHub.
  • docs/lineage/dagster.md
    • -ingestion-modules/dagster-plugin/e... --> -ingestion-modules/dagster-plugin/e...: The documentation needs to include the new feature of using SQL query parsing to extract lineage, which is a significant addition in the code changes. This feature allows automatic capture of dataset inputs and outputs from SQL queries, enhancing the lineage tracking capabilities. Including this information will help users understand and utilize the new functionality effectively.
  • docs/modeling/metadata-model.md
    • ## Exploring DataHub's Metadata Mod... --> ## Exploring DataHub's Metadata Mod...: The code changes introduce new features and improvements to the Dagster integration with DataHub, such as enhanced asset metadata handling, lineage tracking, and SQL query parsing for lineage extraction. The documentation should be updated to reflect these new capabilities, providing users with information on how to leverage these features within the DataHub metadata model.
  • docs/api/openapi/openapi-usage-guide.md
    • ### Writing metadata events to the ... --> ### Writing metadata events to the ...: The code changes introduce new features for capturing asset lineage and metadata in the Dagster integration, which can be emitted using the same OpenAPI methods. The documentation should reflect these new capabilities to guide users on how to utilize them.
    • ## OpenAPI v3 Features### Condition... --> ## OpenAPI v3 Features### Condition...: The documentation should be updated to include information about the new Dagster integration enhancements that support conditional writes for asset metadata, aligning with the existing OpenAPI v3 features.
  • docs/cli.md
    • | [snowflake](./generated/ingestion... --> | [snowflake](./generated/ingestion...: The code changes introduce new features and improvements to the Dagster integration with DataHub. The documentation should include the installation command for the Dagster plugin to inform users about the new Dagster source capabilities.
  • docs/what-is-datahub/datahub-concepts.md
    • ### Ingestion SourceIngestion sourc... --> ### Ingestion SourceIngestion sourc...: The code changes introduce enhancements to the Dagster integration, which should be reflected in the documentation by including Dagster as an example of an ingestion source.
    • ### DatasetDatasets represent colle... --> ### DatasetDatasets represent colle...: The code changes include new features for handling Dagster asset metadata, which should be reflected in the documentation by mentioning Dagster as a platform where datasets can be represented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants