[DOC-372] Saved views guide #23943
[DOC-372] Saved views guide #23943
Conversation
graphite-app
bot
requested review from
PedramNavid,
cmpadden and
erinkcochran87
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @benpankow and the rest of your teammates on |
Graphite Automations"docs-beta - Assign Reviewers" took an action on this PR • (08/27/24)3 reviewers were added to this PR based on Pedram Navid's automation. |
| </details> | ||
|
|
||
|
|
||
| ## Tailored catalog views |
There was a problem hiding this comment.
To me this section is the real benefit of using saved views: I have a way to easily view the assets that I care about most.
What do you think of combining this with the intro instead of having it be its own section? Then the guide would lead with why it's important before getting into the weeds.
Maybe something like:
Catalog views enable you to filter down your view of the Dagster Asset catalog in Dagster+, allowing you to toggle between sets of assets that you care about most.
You can save catalog views for your own use or share them with your team. For example, you could create views that:
- Filter assets based on ownership to only show those owned by your team
- Filter assets based on the asset kind to give insight into the status of your ELT ingestion
- Display assets with a "gold" medallion tag, showing only refined, high-quality data that analysts can use with confidence analysts can use with confidence
In this guide, you'll learn how to create, access, and share catalog views with others.
| ## 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. | ||
|
|
There was a problem hiding this comment.
This would probably benefit from a screenshot. Would you mind adding a TODO for it here?
| 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. |
There was a problem hiding this comment.
What's an asset kind? 🌚
There was a problem hiding this comment.
Should this guide assume some familiarity with asset metadata due to the filter options, which would cover asset kind? If so, we could just list it as a prereq, point folks to the metadata docs + reference, and not have to worry about explaining it
There was a problem hiding this comment.
I think thats a good idea
|
|
||
| - **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. | ||
| - **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. |
| 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. | ||
|
|
There was a problem hiding this comment.
Should we list out somewhere exactly which pages are affected by catalog views?
Catalog search page,
Asset catalog table,
Asset graph,
Asset health dashboard.
There was a problem hiding this comment.
I'm inclined to say no, since the UI makes it fairly obvious that there are filters applied. Curious what others think though
There was a problem hiding this comment.
It might be nice to know -- I didn't actually know where it applied
|
|
||
| ### 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. |
There was a problem hiding this comment.
ah okay we did mention the lineage page :).
erinkcochran87
changed the title
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
benpankow
force-pushed
the
ben/doc-372-write-tailoring-your-search-experience-with-saved-views-and
branch
from
56cbe60 to
32342ba
Compare
Co-authored-by: Erin Cochran <[email protected]>
PedramNavid
deleted the
ben/doc-372-write-tailoring-your-search-experience-with-saved-views-and
branch
Summary & Motivation
Adds a page describing catalog views, how to manipulate them, and potential use-cases.
https://dagster-docs-beta-g3ci1gizo-elementl.vercel.app/dagster-plus/saved-views
Changelog [Docs]
NOCHANGELOG