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

Docs: Updating Chrome Extension Full Doc #18339

Merged
merged 1 commit into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions openmetadata-docs/content/v1.5.x/collate-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,14 @@ site_menu:
url: /how-to-guides/data-discovery/import
- category: How-to Guides / Data Discovery / How to Export Data Asset
url: /how-to-guides/data-discovery/export
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension
url: /how-to-guides/data-discovery/openmetadata-extension
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing Activity Feeds and Managing Tasks
url: /how-to-guides/data-discovery/openmetadata-extension/activity-feeds
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Looking Up Data Assets and Accessing Details
url: /how-to-guides/data-discovery/openmetadata-extension/looking-up
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing tasks & add comment directly from the extension
url: /how-to-guides/data-discovery/openmetadata-extension/viewing-tasks

- category: How-to Guides / Data Collaboration
url: /how-to-guides/data-collaboration
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Viewing Activity Feeds and Managing Tasks
slug: /how-to-guides/data-discovery/openmetadata-extension/activity-feeds
---

# Viewing Activity Feeds and Managing Tasks

- Once logged in, the extension will display activity feeds from the **My Data** page, showing recent changes and updates related to your data assets.

{% image
src="/images/v1.5/how-to-guides/discovery/activity-feeds-and-managing-tasks-1.png"
alt="My Data"
caption="My Data"
/%}

- You can view the list of assigned tasks directly within the extension, keeping track of what needs to be done without switching to a different tool.

{% image
src="/images/v1.5/how-to-guides/discovery/activity-feeds-and-managing-tasks-2.png"
alt="List of Assigned Tasks"
caption="List of Assigned Tasks"
/%}

- The activity feed provides a quick overview of ongoing activities, including comments, updates, and ownership changes.

{% image
src="/images/v1.5/how-to-guides/discovery/activity-feeds-and-managing-tasks-3.png"
alt="Activity Feed"
caption="Activity Feed"
/%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: OpenMetadata Chrome Extension
slug: /how-to-guides/data-discovery/openmetadata-extension
---

# OpenMetadata Chrome Extension

{% youtube videoId="ZQckSIXAA6k" start="0:00" end="01:37" width="560px" height="315px" /%}

# Access Metadata Without Leaving Your Workspace

The OpenMetadata Chrome extension provides a seamless way to interact with metadata directly within your workspace. It allows users to view activity feeds, resolve assigned tasks, and look up data assets without switching between tools or interfaces. This integration enhances productivity by providing instant access to metadata and task management features right from your browser.

## Key Features

### View Activity Feeds and Assigned Tasks
Stay updated on all activities related to your data assets, including any changes, comments, or updates, and manage assigned tasks directly from the extension.

### Resolve Tasks from the Extension
Complete tasks or mark them as resolved without leaving your active workspace, streamlining task management.

### Lookup Data Assets and Understand Asset Details
Quickly search for data assets, view essential metadata such as ownership, descriptions, tags, lineage, and schema, and get a comprehensive understanding of the data asset.

## Benefits of Using the OpenMetadata Chrome Extension

The OpenMetadata Chrome extension provides several benefits that enhance the user experience and productivity by allowing seamless interaction with metadata directly within your workspace. Here are the key benefits:

### Improved Productivity
The extension allows you to access metadata, resolve tasks, and view activity feeds without leaving your active workspace. This eliminates switching between multiple tools or interfaces, helping you focus on your tasks. Are you navigating Tableau, Power BI, or Snowflake? Get all the context from OpenMetadata without breaking your flow.

### Centralized Task Management
It simplifies task management by enabling users to view and resolve tasks directly from the extension. Users can update task statuses, add comments, and mark tasks as complete without navigating away from their current work, ensuring tasks are addressed promptly.

### Instant Access to Metadata
The extension provides quick access to essential metadata such as ownership, descriptions, tags, and data lineage. Users can easily understand the context of their data assets without opening the main OpenMetadata platform.

### Enhanced Data Understanding
With features like data lineage, schema details, and custom properties, the extension helps users understand the relationships and structure of data assets. This is valuable for making informed decisions, troubleshooting data issues, and ensuring data quality.

### Better Data Governance and Compliance
The ability to consistently manage metadata, apply changes, and track updates from the activity feed ensures that data governance policies are followed across the organization. Automating the identification of PII and consistent tagging helps with compliance.

### Real-Time Updates
Stay informed of the latest changes and activities related to your data assets through real-time activity feeds. This ensures you are always aware of updates and can react to data changes quickly.

### Seamless Integration with Existing Workflows
Whether you are working on a Tableau dashboard, a report, or another web application, the extension fits seamlessly into your workflow. You can interact with metadata and data assets from within the same browser, making data exploration and metadata management more intuitive.

## How to Use the Chrome Extension

### 1. Installing and Configuring the Extension

- Visit the Chrome Web Store and search for "Open Metadata."

{% image
src="/images/v1.5/how-to-guides/discovery/extension-1.png"
alt="Visit the Chrome Web Store"
caption="Visit the Chrome Web Store"
/%}

- Add the extension to your Chrome browser and pin it for quick access.

{% image
src="/images/v1.5/how-to-guides/discovery/extension-2.png"
alt="Add Extension to Chrome Browser"
caption="Add extension to chrome browser"
/%}

- Click on the OpenMetadata icon in your browser to open the extension, then add the base URL of your OpenMetadata instance and click **Connect**.

{% image
src="/images/v1.5/how-to-guides/discovery/extension-3.png"
alt="OpenMetadata icon"
caption="Open Metadata icon"
/%}

- The extension will guide you through the sign-in process based on your organization's authentication method.

{% image
src="/images/v1.5/how-to-guides/discovery/extension-4.png"
alt="Sign-in process"
caption="Sign-in process"
/%}

Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Looking Up Data Assets and Accessing Details
slug: /how-to-guides/data-discovery/openmetadata-extension/looking-up
---

# Looking Up Data Assets and Accessing Details

The OpenMetadata Chrome extension allows users to easily look up data assets and access detailed metadata directly from their web browser. This feature provides instant access to essential information about data assets, enabling users to better understand the data they are working with without leaving their current context.

##Looking up data assets using data tools

- The extension is also compatible with data tools like Tableau, allowing you to view detailed metadata for each data asset.
- When you select an asset, the extension provides a detailed view, including:
- **Ownership**: Know who is responsible for the data asset.
- **Description**: Get a brief overview of what the asset is and its purpose.
- **Tags and Glossary Terms**: Understand the categorization and related business terms associated with the asset.
- **Schema Information**: View the structure of the data asset, such as table columns or dashboard charts.
- **Lineage**: See data flow and dependencies, helping you understand the asset's origins and relationships with other data assets.
- **Custom Properties**: Access any additional metadata that has been defined for the asset.

{% image
src="/images/v1.5/how-to-guides/discovery/looking-up-data.png"
alt="Looking Up Data Assets"
caption="Looking Up Data Assets"
/%}

## Looking up data assets using the browse feature

### 1. Search for the Keyword in the Browser
Open a web browser and perform a search for the keyword or term you want to look up.

{% image
src="/images/v1.5/how-to-guides/discovery/browser-extension-1.png"
alt="Search for the Keyword in the Browser"
caption="Search for the Keyword in the Browser"
/%}

### 2. Select the Desired Text
After finding the relevant information, highlight the specific text or term.

### 3. Right-Click on the Selected Text
Open the context menu by right-clicking on the highlighted text.

### 4. Choose "Search in OpenMetadata"
Click on the "Search in OpenMetadata" option from the context menu.

{% image
src="/images/v1.5/how-to-guides/discovery/browser-extension-2.png"
alt="Search in OpenMetadata"
caption="Search in OpenMetadata"
/%}

### 5. View Search Results in OpenMetadata
The extension will initiate a search in OpenMetadata and display results based on the selected text. The search results may include:

- **Glossary Terms**: Definitions, descriptions, and related business terms.
- **Tables**: Information about database tables, including schema, ownership, and descriptions.
- **Topics**: Relevant topics or subject areas in the data catalog.
- **Stored Procedures**: Details about database procedures, including usage and associated documentation.
- **Ingestion Pipelines**: Information about data pipelines, including statuses and configurations.
- **Dashboards**: Metadata for analytics dashboards, including ownership, tags, and lineage.

{% image
src="/images/v1.5/how-to-guides/discovery/browser-extension-3.png"
alt="View Search Results in OpenMetadata"
caption="View Search Results in OpenMetadata"
/%}

### 6. Explore the Search Results
Click on any result to view detailed metadata, including descriptions, tags, schema details, ownership, and lineage information. Use this information to gain insights into the data asset and understand its relevance to your current context.

{% image
src="/images/v1.5/how-to-guides/discovery/browser-extension-4.png"
alt="Explore the Search Results"
caption="Explore the Search Results"
/%}

## Best Practices

- **Pin the Extension for Easy Access**: Pinning the OpenMetadata extension ensures that it is readily accessible whenever you need to view activity feeds, manage tasks, or look up data assets.
- **Regularly Check Activity Feeds**: Use the extension to stay updated on data-related activities, ensuring you are aware of any changes, comments, or updates to your data assets.
- **Resolve Tasks as Soon as Possible**: Managing and completing tasks directly from the extension helps maintain data quality and governance by ensuring that assigned tasks are addressed promptly.
- **Use the Lookup Feature for Quick Data Insights**: Leverage the lookup feature to get instant access to data asset details, making it easier to understand data context without switching between different tools.
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: View tasks & add comment directly from the extension
slug: /how-to-guides/data-discovery/openmetadata-extension/viewing-tasks
---

## Viewing tasks & add comment directly from the extension

- Click on any task in the activity feed to view its details.

{% image
src="/images/v1.5/how-to-guides/discovery/resolving-tasks-1.png"
alt="Task in the Activity Feed"
caption="Task in the Activity Feed"
/%}

- You can view tasks, assignees, and add comments directly through the extension.

{% image
src="/images/v1.5/how-to-guides/discovery/resolving-tasks-2.png"
alt="View Tasks"
caption="View Tasks"
/%}

- This feature allows you to manage tasks and stay up-to-date without leaving your current workspace, increasing efficiency.

{% image
src="/images/v1.5/how-to-guides/discovery/resolving-tasks-3.png"
alt="Manage Tasks"
caption="Manage Tasks"
/%}
8 changes: 8 additions & 0 deletions openmetadata-docs/content/v1.5.x/menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -765,6 +765,14 @@ site_menu:
url: /how-to-guides/data-discovery/details
- category: How-to Guides / Data Discovery / Add Complex Queries using Advanced Search
url: /how-to-guides/data-discovery/advanced
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension
url: /how-to-guides/data-discovery/openmetadata-extension
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing Activity Feeds and Managing Tasks
url: /how-to-guides/data-discovery/openmetadata-extension/activity-feeds
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Looking Up Data Assets and Accessing Details
url: /how-to-guides/data-discovery/openmetadata-extension/looking-up
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing tasks & add comment directly from the extension
url: /how-to-guides/data-discovery/openmetadata-extension/viewing-tasks

- category: How-to Guides / Data Collaboration
url: /how-to-guides/data-collaboration
Expand Down
8 changes: 8 additions & 0 deletions openmetadata-docs/content/v1.6.x-SNAPSHOT/collate-menu.md
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,14 @@ site_menu:
url: /how-to-guides/data-discovery/import
- category: How-to Guides / Data Discovery / How to Export Data Asset
url: /how-to-guides/data-discovery/export
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension
url: /how-to-guides/data-discovery/openmetadata-extension
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing Activity Feeds and Managing Tasks
url: /how-to-guides/data-discovery/openmetadata-extension/activity-feeds
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Looking Up Data Assets and Accessing Details
url: /how-to-guides/data-discovery/openmetadata-extension/looking-up
- category: How-to Guides / Data Discovery / OpenMetadata Chrome Extension / Viewing tasks & add comment directly from the extension
url: /how-to-guides/data-discovery/openmetadata-extension/viewing-tasks

- category: How-to Guides / Data Collaboration
url: /how-to-guides/data-collaboration
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Viewing Activity Feeds and Managing Tasks
slug: /how-to-guides/data-discovery/openmetadata-extension/activity-feeds
---

# Viewing Activity Feeds and Managing Tasks

- Once logged in, the extension will display activity feeds from the **My Data** page, showing recent changes and updates related to your data assets.

{% image
src="/images/v1.6/how-to-guides/discovery/activity-feeds-and-managing-tasks-1.png"
alt="My Data"
caption="My Data"
/%}

- You can view the list of assigned tasks directly within the extension, keeping track of what needs to be done without switching to a different tool.

{% image
src="/images/v1.6/how-to-guides/discovery/activity-feeds-and-managing-tasks-2.png"
alt="List of Assigned Tasks"
caption="List of Assigned Tasks"
/%}

- The activity feed provides a quick overview of ongoing activities, including comments, updates, and ownership changes.

{% image
src="/images/v1.6/how-to-guides/discovery/activity-feeds-and-managing-tasks-3.png"
alt="Activity Feed"
caption="Activity Feed"
/%}
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
title: OpenMetadata Chrome Extension
slug: /how-to-guides/data-discovery/openmetadata-extension
---

# OpenMetadata Chrome Extension

{% youtube videoId="ZQckSIXAA6k" start="0:00" end="01:37" width="560px" height="315px" /%}

# Access Metadata Without Leaving Your Workspace

The OpenMetadata Chrome extension provides a seamless way to interact with metadata directly within your workspace. It allows users to view activity feeds, resolve assigned tasks, and look up data assets without switching between tools or interfaces. This integration enhances productivity by providing instant access to metadata and task management features right from your browser.

## Key Features

### View Activity Feeds and Assigned Tasks
Stay updated on all activities related to your data assets, including any changes, comments, or updates, and manage assigned tasks directly from the extension.

### Resolve Tasks from the Extension
Complete tasks or mark them as resolved without leaving your active workspace, streamlining task management.

### Lookup Data Assets and Understand Asset Details
Quickly search for data assets, view essential metadata such as ownership, descriptions, tags, lineage, and schema, and get a comprehensive understanding of the data asset.

## Benefits of Using the OpenMetadata Chrome Extension

The OpenMetadata Chrome extension provides several benefits that enhance the user experience and productivity by allowing seamless interaction with metadata directly within your workspace. Here are the key benefits:

### Improved Productivity
The extension allows you to access metadata, resolve tasks, and view activity feeds without leaving your active workspace. This eliminates switching between multiple tools or interfaces, helping you focus on your tasks. Are you navigating Tableau, Power BI, or Snowflake? Get all the context from OpenMetadata without breaking your flow.

### Centralized Task Management
It simplifies task management by enabling users to view and resolve tasks directly from the extension. Users can update task statuses, add comments, and mark tasks as complete without navigating away from their current work, ensuring tasks are addressed promptly.

### Instant Access to Metadata
The extension provides quick access to essential metadata such as ownership, descriptions, tags, and data lineage. Users can easily understand the context of their data assets without opening the main OpenMetadata platform.

### Enhanced Data Understanding
With features like data lineage, schema details, and custom properties, the extension helps users understand the relationships and structure of data assets. This is valuable for making informed decisions, troubleshooting data issues, and ensuring data quality.

### Better Data Governance and Compliance
The ability to consistently manage metadata, apply changes, and track updates from the activity feed ensures that data governance policies are followed across the organization. Automating the identification of PII and consistent tagging helps with compliance.

### Real-Time Updates
Stay informed of the latest changes and activities related to your data assets through real-time activity feeds. This ensures you are always aware of updates and can react to data changes quickly.

### Seamless Integration with Existing Workflows
Whether you are working on a Tableau dashboard, a report, or another web application, the extension fits seamlessly into your workflow. You can interact with metadata and data assets from within the same browser, making data exploration and metadata management more intuitive.

## How to Use the Chrome Extension

### 1. Installing and Configuring the Extension

- Visit the Chrome Web Store and search for "Open Metadata."

{% image
src="/images/v1.6/how-to-guides/discovery/extension-1.png"
alt="Visit the Chrome Web Store"
caption="Visit the Chrome Web Store"
/%}

- Add the extension to your Chrome browser and pin it for quick access.

{% image
src="/images/v1.6/how-to-guides/discovery/extension-2.png"
alt="Add Extension to Chrome Browser"
caption="Add extension to chrome browser"
/%}

- Click on the OpenMetadata icon in your browser to open the extension, then add the base URL of your OpenMetadata instance and click **Connect**.

{% image
src="/images/v1.6/how-to-guides/discovery/extension-3.png"
alt="OpenMetadata icon"
caption="Open Metadata icon"
/%}

- The extension will guide you through the sign-in process based on your organization's authentication method.

{% image
src="/images/v1.6/how-to-guides/discovery/extension-4.png"
alt="Sign-in process"
caption="Sign-in process"
/%}

Loading
Loading