[dagster-tableau] Update docs with refreshable workbooks and materialization #24864
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @maximearmstrong and the rest of your teammates on |
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-exe6obn0j-elementl.vercel.app Direct link to changed pages: |
Graphite Automations"Label and add CE on all Docs" took an action on this PR • (09/30/24)2 reviewers were added and 1 label was added to this PR based on Pedram Navid's automation. |
PedramNavid
requested changes
Oct 1, 2024
|
|
||
| ### Refresh and materialize Tableau assets | ||
|
|
||
| You can use Dagster to orchestrate the refreshment of Tableau workbooks and materialization of Looker sheets and dashboards. |
There was a problem hiding this comment.
Suggested change
| You can use Dagster to orchestrate the refreshment of Tableau workbooks and materialization of Looker sheets and dashboards. | |
| You can use Dagster to refresh Tableau workbooks and materialize Looker sheets and dashboards. |
|
|
||
| You can use Dagster to orchestrate the refreshment of Tableau workbooks and materialization of Looker sheets and dashboards. | ||
|
|
||
| To refresh a Tableau workbook with Dagster, pass its definition by passing `StartWorkbookRefreshRequest` to `TableauCloudWorkspace.build_defs(...)` function. |
There was a problem hiding this comment.
I would skip this line and just go straight to the code, as the code will show this exact thing.
|
|
||
| Note that only workbooks created with extracts can be refreshed using this method. See more about [refreshing data sources](https://help.tableau.com/current/pro/desktop/en-us/refreshing_data.htm) in Tableau documentation website. | ||
|
|
||
| When materializing the Tableau assets, Dagster will refresh the workbooks for which a `StartWorkbookRefreshRequest` has been created. Dagster will materialize the sheets and dashboards of workbooks that have been refreshed as `AssetMaterialization`, and the sheets and dashboards of the workbooks that have not been refreshed as `AssetObservation`. |
There was a problem hiding this comment.
This is a little confusing. Does a user need to know the distinction here? I think I would remove this whole paragraph. The API docs for StartWorkbookRefreshRequest should outline what this function does, but I don't think the guide needs it.
There was a problem hiding this comment.
That makes sense. All changes requested done in b954994
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
dca7f72
to
7cefd11
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
from
5ae5552
to
fb3baa3
Compare
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
7cefd11
to
f764c68
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
from
fb3baa3
to
3f66753
Compare
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
f764c68
to
a805ad2
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
from
3f66753
to
4fb4cdf
Compare
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
a805ad2
to
3c010c6
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
from
4fb4cdf
to
c9cbeb5
Compare
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
3c010c6
to
1ddbbaa
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
2 times, most recently
from
107748d
to
85af2a8
Compare
maximearmstrong
force-pushed
the
maxime/implement-tableau-refreshable-workbooks
branch
from
8dfb00b
to
f0bb010
Compare
maximearmstrong
force-pushed
the
maxime/update-tableau-docs-with-refresh-and-materialization
branch
from
85af2a8
to
b954994
Compare
Base automatically changed from
maxime/implement-tableau-refreshable-workbooks
to
master
October 4, 2024 01:40
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary & Motivation
As title.
How I Tested These Changes
Docs preview
Changelog
NOCHANGELOG