Added overview docs to activate the section links (#13353)

This commit is contained in:
Shilpa Vernekar 2023-09-28 15:13:23 +05:30 committed by GitHub
parent 6e5ad3f44c
commit 351c20e23a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 340 additions and 21 deletions

View File

@ -0,0 +1,19 @@
---
title: Data Collaboration
slug: /how-to-guides/openmetadata/data-collaboration
---
# Overview of Data Collaboration
OpenMetadata is a catalyst for collaboration that brings data teams together to break the information silos, share organizational knowledge, and sort the data deluge. Users can add documentation, descriptions, and annotations to metadata to provide context and share knowledge about data assets. This encourages collaboration among data users and enhances data understanding.
There are three important aspects of data collaboration in OpenMetadata:
- **Conversations Threads:** Collaborate around data assets and tags by asking the right questions and discussing the details right within OpenMetadata.
- **Tasks:** Create tasks around data assets to create and update descriptions, request for tags, and initaite a glossary term approval workflow.
- **Announcements:** Announce to your entire team about the upcoming events and changes such as deprecation, deletion, or schema changes.
Watch the video on how to use the collaboration features in OpenMetadata.
{% youtube videoId="M6mbFLA1bQc" start="0:00" end="5:58" /%}

View File

@ -0,0 +1,115 @@
---
title: How to Discover Assets of Interest
slug: /how-to-guides/openmetadata/data-discovery/discover
---
# How to Discover Assets of Interest
Search is at the front and center of OpenMetadata and is available in the top Menu bar across all the different pages. OpenMetadata simplifies data discovery with the following strategies.
## Keyword Search
A simple yet powerful way to find assets by typing the name or description from the search interface. The search suggest will display matching data assets in several categories. Your query will retrieve all matching tables, topics, dashboards, pipelines, ML models, containers, glossaries, and tags. Your queries will match names for data assets and their components, such as column names for tables and chart names for dashboards. The queries will also match the descriptions used.
{% image
src="/images/v1.1/how-to-guides/discovery/kw.png"
alt="Keyword Search"
caption="Keyword Search"
/%}
Multiple filter options further help to narrow down the search by Owner, Tag, Tier, Service, Service Type, and other filters relevant to the type of data asset. You can also search by deleted data assets.
{% image
src="/images/v1.1/how-to-guides/discovery/kw2.png"
alt="Filter using Multiple Parameters"
caption="Filter using Multiple Parameters"
/%}
## Filter by the Type of Data Asset
The search results can be narrowed down by data assets such as Table, Topic, Dashboard, Pipeline, ML Model, Container, Glossary, or Tag.
{% image
src="/images/v1.1/how-to-guides/discovery/da1.png"
alt="Filter by the Type of Data Asset"
caption="Filter by the Type of Data Asset"
/%}
Users can navigate to the Explore page for specific type of data assets and use the filter options relevant to that data assset to narrow down the search.
## Filter by Database
When searching while you are in a database page, you can narrow down your search to within the database or to include the overall search results within OpenMetadata.
{% image
src="/images/v1.1/how-to-guides/discovery/db.png"
alt="Filter by Database"
caption="Filter by Database"
/%}
## Filter based on Importance: Tiers
Using tiers, you can search for data based on importance.
{% image
src="/images/v1.1/how-to-guides/discovery/tier.png"
alt="Filter based on Importance using Tiers"
caption="Filter based on Importance using Tiers"
/%}
## Filter based on Importance: Usage
OpenMetadata captures usage profiles for tables during metadata/profiler ingestion. This helps to learn how other data consumers are using the tables. You can search by weekly usage, last updated status, as well as relevance.
{% image
src="/images/v1.1/how-to-guides/discovery/usage.png"
alt="Filter based on Importance: Usage"
caption="Filter based on Importance: Usage"
/%}
## Filter by Asset Owner
A team or a user can own the data asset in OpenMetadata. Users can filter data assets by the asset owner. With information on the data asset owners, you can direct your questions to the right person or team.
{% image
src="/images/v1.1/how-to-guides/discovery/owner.png"
alt="Filter by Asset Owner"
caption="Filter by Asset Owner"
/%}
## Discover Data through Association
OpenMetadata provides the links to the frequently joined tables and columns as measured by the data profiler. You can also discover assets through relationships based on data lineage.
{% image
src="/images/v1.1/how-to-guides/discovery/fjt.png"
alt="Frequently Joined Tables"
caption="Frequently Joined Tables"
/%}
## Discover Assets through Relationships
OpenMetadata helps to locate assets of interest by tracing data lineage. You can view the upstream and downstream nodes to discover the sources of data and learn about the tables, pipelines, and more. The table and column descriptions help to decide if the data is helpful for your use case. Similarly, the pipeline description helps to uncover the transformation and more data of interest.
{% image
src="/images/v1.1/how-to-guides/discovery/lineage.png"
alt="Discover Assets through Relationships: Lineage"
caption="Discover Assets through Relationships: Lineage"
/%}
## Advanced Search
Users can find data assets matching strict criteria by multiple parameters on metadata properties, using the **syntax editor** with and/or conditions. Advanced search in OpenMetadata supports Boolean operators and faceted queries to search for specific facets of your data. Separate advanced search options are available for Tables, Topics, Dashboards, Pipelines, ML Models, Containers, Glossary, and Tags.
{% image
src="/images/v1.1/features/data-discovery.gif"
/%}
## Discover Data Evolution
By viewing lineage and metadata versioning, users can discover the data evolution of data assets.
{% image
src="/images/v1.1/how-to-guides/discovery/version.png"
alt="Discover Data Evolution: Version History"
caption="Discover Data Evolution: Version History"
/%}
## Filter by Deleted Data Assets
Users can also search for the deleted data assets in OpenMetadata.
{% image
src="/images/v1.1/how-to-guides/discovery/deleted.png"
alt="Filter by Deleted Data Assets"
caption="Filter by Deleted Data Assets"
/%}

View File

@ -0,0 +1,29 @@
---
title: Data Discovery
slug: /how-to-guides/openmetadata/data-discovery
---
# Overview of Data Discovery
Discovering data among thousands of datasets is hard without rich metadata and faceted search. OpenMetadata with a single catalog aggregates metadata about all data assets, and presents the right information to users depending on their needs. OpenMetadata aims to help **data producers** make smart decisions to evolve data and prioritize bug fixes; and help **data consumers** make timely decisions with the right data.
OpenMetadata provides a user-friendly interface for **data discovery**. OpenMetadata enables you to discover your data using a variety of strategies, including: keyword search, data associations (e.g., frequently joined tables, lineage), and complex queries. Using OpenMetadata you can search across tables, topics, dashboards, pipelines, ML models, containers, glossaries, and tags. OpenMetadata supports detailed metadata for assets and their components (e.g., columns, charts), including support for complex data types such as arrays and structs. Users can get a complete picture of their data by viewing the **data evolution** tracked using lineage and metadata versioning.
{% image
src="/images/v1.1/features/data-discovery.gif"
/%}
Watch the video on how easy it is to discovery your data in OpenMetadata.
{% youtube videoId="3xaHf3A2PgU" start="0:00" end="3:17" /%}
{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="How to Discover Assets of Interest"
icon="MdSearch"
href="/how-to-guides/openmetadata/data-discovery/discover"%}
Discover the right data assets quickly.
{%/inlineCallout%}
{%/inlineCalloutContainer%}

View File

@ -12,7 +12,7 @@ Glossary adds semantics or meaning to data. OpenMetadata models a Glossary as a
The Glossary in OpenMetadata can be accessed from **Govern >> Glossary**. All the Glossaries are displayed in the left nav bar. Clicking on a specific glossary will display the expanded view to show the entire hierarchy of the glossary terms (parent-child terms).
{% image
src="/images/v1.1/how-to-guides/governance/glossary0.png"
src="/images/v1.1/how-to-guides/governance/banking.png"
alt="Banking Glossary"
caption="Banking Glossary"
/%}

View File

@ -0,0 +1,18 @@
---
title: Data Insights
slug: /how-to-guides/openmetadata/data-insights
---
# Overview of Data Insights
OpenMetadata is a centralized, active metadata repository where all your data resides. Organizations can drive the adoption of OpenMetadata by monitoring its usage and setting up company-wide KPIs. The built-in goal-setting and tracking mechanisms help proactively drive your company's data culture. You can define the **Key Performance Indicators** and set goals to be achieved within a timeframe towards **better documentation, ownership, and tiering**.
The **Data Insights Dashboard** provides an analytical view of all the key metrics around data assets and user activity. The KPIs help to drive platform adoption. You can monitor data health and track the progress toward the organizational goals. The Data Insights Report is emailed at a regular cadence so that teams can assess their performance relative to the KPIs to determine data ownership, tiering, and documentation. You can also assess user engagement and growth with the aggregated user activity.
Watch the video to learn more about proactively honing the data culture of your company by setting targets, monitoring, and boosting teams to accomplish data goals.
{% youtube videoId="lOQepnTdA58" start="0:00" end="58:23" /%}
Watch a demo of Data Insights in OpenMetadata
{% youtube videoId="Epd9G6igLUM" start="0:00" end="21:58" /%}

View File

@ -0,0 +1,12 @@
---
title: Data Lineage
slug: /how-to-guides/openmetadata/data-lineage
---
# Overview of Data Lineage
OpenMetadata tracks data lineage, showing how data moves through the organization's systems. Users can visualize how data is transformed and where it is used, helping with data traceability and impact analysis.
Watch the video on data lineage to understand the different options to automatically extract the lineage from your data warehouses such as Snowflake, dashboard service like metabase. Also learn about creating lineage programmatically with python SDK.
{% youtube videoId="jEbN1tt89H0" start="0:00" end="41:43" /%}

View File

@ -0,0 +1,17 @@
---
title: Data Quality and Profiler
slug: /how-to-guides/openmetadata/data-quality-profiler
---
# Overview of Data Quality and Profiler
With OpenMetadata, you can build trust in your data by creating tests to monitor that the data is complete, fresh, and accurate. The data profiler helps to capture table usage statistics over a period of time. This happens as part of profiler ingestion. Data profiles enable you to check for null values in non-null columns, for duplicates in a unique column, etc. You can gain a better understanding of column data distributions through the descriptive statistics provided.
Watch the video to understand OpenMetadatas native Data Profiler and Data Quality tests.
{% youtube videoId="gLdTOF81YpI" start="0:00" end="1:08:10" /%}
Watch the video on Data Quality Simplified to effortlessly build, deploy, monitor, and configure alerts using OpenMetadata's no-code platform
{% youtube videoId="ihwtuNHt1kI" start="0:00" end="29:08" /%}

View File

@ -1,5 +1,5 @@
---
title: The Pillars of OpenMetadata
title: The Six Pillars of OpenMetadata
slug: /how-to-guides/openmetadata
---
@ -9,10 +9,49 @@ OpenMetadata is an all-in-one platform for data discovery, lineage, data quality
OpenMetadata is a complete package for data teams to break down team silos, share data assets from multiple sources securely, collaborate around data, and build a documentation-first data culture in the organization.
Let us learn more about the six pillars of OpenMetadata that helps maintain its ground as the best in effective metadata management:
1. Data Discovery,
2. Data Collaboration,
3. Data Quality and Profiler,
4. Data Lineage,
5. Data insights, and
6. [Data Governance](/how-to-guides/openmetadata/data-governance).
Let us learn more about the six pillars of OpenMetadata that helps maintain its ground as the best in effective metadata management.
{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="Data Discovery"
icon="MdSearch"
href="/how-to-guides/openmetadata/data-discovery"%}
Discover the right data assets to make timely business decisions.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Data Collaboration"
icon="MdGroups"
href="/how-to-guides/openmetadata/data-collaboration"%}
Foster data team collaboration to enhance data understanding.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Data Quality and Profiler"
icon="MdSecurity"
href="/how-to-guides/openmetadata/data-quality-profiler"%}
Trust your data with quality tests that ensure freshness, & accuracy.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Data Lineage"
icon="MdPolyline"
href="/how-to-guides/openmetadata/data-lineage"%}
Trace the path of data across tables, pipelines, and dashboards.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Data Insights"
icon="MdInsertChart"
href="/how-to-guides/openmetadata/data-insights"%}
Define KPIs and set goals to proactively hone the data culture of your company.
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Data Governance"
icon="MdMenuBook"
href="/how-to-guides/openmetadata/data-governance"%}
Enhance your data platform governance using OpenMetadata.
{%/inlineCallout%}
{%/inlineCalloutContainer%}

View File

@ -0,0 +1,49 @@
---
title: How to Assign or Change Data Ownership
slug: /how-to-guides/user-guide-for-data-stewards/overview-data-assets/data-ownership
---
# How to Assign or Change Data Ownership
## Data Asset Ownership
In OpenMetadata, either a **team** or an **individual user** can be the owner of a data asset. Owners have access to perform all the operations on a data asset. For example, edit description, tags, glossary terms, etc.
## Assign Data Ownership
Admin users have access to add or change data ownership.
- Navigate to the data asset and click on the edit icon next to the Owner of the data asset.
- Select a Team or a User as the Owner of the Data Asset.
{% image
src="/images/v1.1/how-to-guides/user-guide-for-data-stewards/data-owner1.png"
alt="Assign an Owner to a Data Asset"
caption="Assign an Owner to a Data Asset"
/%}
## Change Data Ownership
If the data asset already has an owner, you can change the owner by clicking on the edit icon for Owner and simply selecting a team or user to change ownership.
{% image
src="/images/v1.1/how-to-guides/user-guide-for-data-stewards/data-owner2.png"
alt="Change the Owner of the Data Asset"
caption="Change the Owner of the Data Asset"
/%}
If no owner is selected, and if the Database or Database Schema has a owner, then by default the same owner will be assigned to the Database Schema or Table respectively, based on the owner propagation in OpenMetadata.
## Owner Propagation in OpenMetadata
OpenMetadata supports Owner Propagation and the owner will be propagated based on a top-down hierarchy. The owner of the Database will be auto-propagated as the owner of the Database Schemas and Tables under it. Similarly, the owner of the Database Schema will be auto-propagated as the owner of the Tables under it.
- Owner Propogation does not work for data assets that already have an Owner assigned to them. If there is **no owner**, then an Owner will be assigned based on the hierarchy.
- If a Database or Database Schema has an Owner assigned, and you **delete the owner** from the Database Schema or Tables under it, then the Owner will be auto-assigned in this case based on the existing Owner details at the top hierarchy.
- You can also assign a different owner manually.
## Team Ownership is Preffered
OpenMetadata is a data collaboration platform. We highly recommend Team Ownership of data assets, because individual users will only have part of the context about the data asset in question. Assigning team ownership will give access to all the members of a particular team. Only teams of the type **Groups** can own data assets.

View File

@ -8,6 +8,13 @@ slug: /how-to-guides/user-guide-for-data-stewards/overview-data-assets
This section will deal with all the details related to data assets: how to change data ownership, how to add tags, glossary terms, announcements, how to follow data assets, how data assets versioning works, and so on.
{%inlineCalloutContainer%}
{%inlineCallout
color="violet-70"
bold="Data Ownership"
icon="add_moderator"
href="/how-to-guides/user-guide-for-data-stewards/overview-data-assets/data-ownership"%}
Learn how to assign or change data owners
{%/inlineCallout%}
{%inlineCallout
color="violet-70"
bold="Follow a Data Asset"

View File

@ -603,35 +603,49 @@ site_menu:
url: /how-to-guides/user-guide-for-data-stewards/basics-openmetadata
- category: How to Guides / User Guide for Data Stewards / Overview of Data Assets
url: /how-to-guides/user-guide-for-data-stewards/overview-data-assets
- category: How to Guides / User Guide for Data Stewards / Overview of Data Assets / How to Assign or Change Data Ownership
url: /how-to-guides/user-guide-for-data-stewards/overview-data-assets/data-ownership
- category: How to Guides / User Guide for Data Stewards / Overview of Data Assets / How to Follow a Data Asset
url: /how-to-guides/user-guide-for-data-stewards/overview-data-assets/follow-data-asset
- category: How to Guides / User Guide for Data Stewards / Overview of Data Assets / Overview of Announcements
url: /how-to-guides/user-guide-for-data-stewards/overview-data-assets/announcements
- category: How to Guides / User Guide for Data Stewards / Overview of Data Assets / How to Create an Announcement
url: /how-to-guides/user-guide-for-data-stewards/overview-data-assets/add-announcement
- category: How to Guides / The Pillars of OpenMetadata
- category: How to Guides / The Six Pillars of OpenMetadata
url: /how-to-guides/openmetadata
- category: How to Guides / The Pillars of OpenMetadata / Data Governance
- category: How to Guides / The Six Pillars of OpenMetadata / Data Discovery
url: /how-to-guides/openmetadata/data-discovery
- category: How to Guides / The Six Pillars of OpenMetadata / Data Discovery / How to Discover Assets of Interest
url: /how-to-guides/openmetadata/data-discovery/discover
- category: How to Guides / The Six Pillars of OpenMetadata / Data Collaboration
url: /how-to-guides/openmetadata/data-collaboration
- category: How to Guides / The Six Pillars of OpenMetadata / Data Quality and Profiler
url: /how-to-guides/openmetadata/data-quality-profiler
- category: How to Guides / The Six Pillars of OpenMetadata / Data Lineage
url: /how-to-guides/openmetadata/data-lineage
- category: How to Guides / The Six Pillars of OpenMetadata / Data Insights
url: /how-to-guides/openmetadata/data-insights
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance
url: /how-to-guides/openmetadata/data-governance
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification
url: /how-to-guides/openmetadata/data-governance/glossary-classification
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / What is a Glossary
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / What is a Glossary
url: /how-to-guides/openmetadata/data-governance/glossary-classification/glossary
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / What is Classification
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / What is Classification
url: /how-to-guides/openmetadata/data-governance/glossary-classification/classification
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / What are Tiers
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / What are Tiers
url: /how-to-guides/openmetadata/data-governance/glossary-classification/tiers
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Setup a Glossary
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Setup a Glossary
url: /how-to-guides/openmetadata/data-governance/glossary-classification/setup-glossary
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Create Glossary Terms
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Create Glossary Terms
url: /how-to-guides/openmetadata/data-governance/glossary-classification/glossary-terms
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Bulk Import a Glossary
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Bulk Import a Glossary
url: /how-to-guides/openmetadata/data-governance/glossary-classification/import-glossary
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Add Assets to Glossary Terms
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Add Assets to Glossary Terms
url: /how-to-guides/openmetadata/data-governance/glossary-classification/assets
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Classify Data Assets
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / How to Classify Data Assets
url: /how-to-guides/openmetadata/data-governance/glossary-classification/classify-assets
- category: How to Guides / The Pillars of OpenMetadata / Data Governance / Glossary and Classification / Best Practices for Glossary and Classification
- category: How to Guides / The Six Pillars of OpenMetadata / Data Governance / Glossary and Classification / Best Practices for Glossary and Classification
url: /how-to-guides/openmetadata/data-governance/glossary-classification/best-practices
- category: How to Guides / CLI Ingestion with basic auth
url: /how-to-guides/cli-ingestion-with-basic-auth

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 511 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 240 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 284 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 937 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 292 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 660 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 984 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 576 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 879 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 623 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 626 KiB