Skip to content

Commit

Permalink
[DOC-374] Saved views guide
Browse files Browse the repository at this point in the history
  • Loading branch information
benpankow committed Aug 27, 2024
1 parent bb0ede8 commit f89ed70
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 1 deletion.
62 changes: 62 additions & 0 deletions docs/docs-beta/docs/dagster-plus/saved-views.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: "Tailoring your search experience with catalog views"
displayed_sidebar: "dagsterPlus"
sidebar_label: "Customizing the catalog with views"
---

# Tailoring your search experience with catalog views

Catalog views enable you to filter down your view of the Dagster Asset catalog in Dagster+. You can save catalog views for your own use, or share them with your team.

This guide covers how to create, access, and share catalog views with others.


<details>
<summary>Prerequisites</summary>

- A Dagster+ organization
- Familiarity with [Assets](/concepts/assets)

</details>


## Create catalog views

In any Dagster+ catalog page, you can access the current catalog view, or create a new catalog view with the catalog view button on the top left of the screen. By default, this button is labeled "All assets", and has a globe icon.

To create a new catalog view, you have two options:
1. Create a new catalog view from scratch, from the catalog view menu.
2. Create a new catalog view from your current set of filters.

### Create a new catalog view from scratch

To build a new catalog view, click the catalog view button to open the catalog view menu. From here, click the "New" button.

Give your view a name and optionally a description and icon. Next, you can select one or more filters to apply to your view by clicking the "Add filters" button. Filters can select a subset of assets based on their metadata, tags, kinds, owners, asset groups, or other properties.

Finally, you can choose whether to share your view with your team, or keep it private to yourself by toggling the "Public view" switch.

To finish, click "Create view" to finalize your new catalog view.

### Create a new catalog view from your current set of filters

When viewing the global asset lineage or asset list, you can create a new catalog view from your current set of filters. First, select one or more asset filters. Then, on the top right of the screen, click the "Create new catalog view" button. This will open the catalog view creation dialog with your current filters pre-populated.

From here, give your view a name and optionally a description and icon. You can also choose whether to share your view with your team, or keep it private to yourself by toggling the "Public view" switch.

To finish, click "Create view" to finalize your new catalog view.

## Edit, duplicate, or delete catalog views

To edit, duplicate, or delete a catalog view, navigate to the catalog view menu by clicking the catalog view button on the top left of the screen. From here, you can search for the view you want to modify, duplicate, or delete. Use the three-dot menu on the right side of the view to show the available actions.

When editing a catalog view, any active filters will automatically be included in the set of changes. You can modify the view's name, description, icon, and sharing settings. To save your changes, click "Save changes".


## Tailored catalog views

Catalog views allow you to toggle between sets of assets that you care about most. Here are a few examples of how your team might use catalog views:

- **Team view**: A view that filters assets based on ownership to show only the assets owned by your team.
- **Ingestion view**: A view that filters assets based on the asset kind to give insight into the status of your ELT ingestion.

Check warning on line 61 in docs/docs-beta/docs/dagster-plus/saved-views.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Dagster.acronyms] Spell out 'ELT', if it's unfamiliar to the audience. Raw Output: {"message": "[Dagster.acronyms] Spell out 'ELT', if it's unfamiliar to the audience.", "location": {"path": "docs/docs-beta/docs/dagster-plus/saved-views.md", "range": {"start": {"line": 61, "column": 114}}}, "severity": "INFO"}
- **Gold medallion view**: A view which displays assets that have a "gold" medallion tag, showing only refined, high-quality data that analysts can use with confidence.
6 changes: 5 additions & 1 deletion docs/docs-beta/sidebars.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';

/**
* Creating a sidebar enables you to:
Expand Down Expand Up @@ -363,6 +363,10 @@ const sidebars: SidebarsConfig = {
},
],
},
{
type: 'doc',
id: 'dagster-plus/saved-views',
},
],
},
{
Expand Down

0 comments on commit f89ed70

Please sign in to comment.