Page MenuHomePhabricator

Add Code Snippet for Metadata and custom Type Checks
Needs RevisionPublic

Authored by yichendai on Fri, Oct 2, 5:40 PM.

Details

Reviewers
max
Summary

Clarify what to provide in yaml for custom_types_4.py pipeline execution

Test Plan

Testing Changing tutorial

Testing Changing tutorial

Diff Detail

Repository
R1 dagster
Branch
rev6
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

max requested changes to this revision.Fri, Oct 2, 6:01 PM
max added inline comments.
docs/next/src/pages/tutorial/types.mdx
257

"You can run this pipeline with config like the following:"

257–262

missing period

This revision now requires changes to proceed.Fri, Oct 2, 6:01 PM

Rephrase

Updating D4645: Add Code Snippet for Metadata and custom Type Checks

max requested changes to this revision.Wed, Oct 7, 2:49 PM

This is ok as a standalone change, req'ing changes for discussion. Do we want to provide config for *all* of the examples on this page? If not, why not? Seems inconsistent.

This revision now requires changes to proceed.Wed, Oct 7, 2:49 PM
In D4645#126650, @max wrote:

Do we want to provide config for *all* of the examples on this page? If not, why not? Seems inconsistent.

I believe we should provide config explicitly for all the examples that ask the reader to run a pipeline (not limit to this page). For the readers' convenience, our plan can be providing the config code snippet in the paragraph, and linking the title of the pipeline script to the source code. In this case, the reader can change the steps of scrolling all the way up, going back to github and looking for both script and yaml files to going to the script directly and copying paste the config.