Page MenuHomePhabricator

Fix Docs Small Bugs in Dagster Types Chapter
AbandonedPublic

Authored by yichendai on Thu, Oct 1, 12:04 AM.

Details

Reviewers
yuhan
max
Summary
  1. Changed the Subtitle "Tutorials" to "Before We Start" Tutorials; otherwise it seems repeated.
  2. Replace an Image to Highlight the Concept "SimpleDataFrame" in Dagster Types

3-1. Remind the user to add config before launching execution.
3-2. Update the error message for running custom_types_2.py with read_csv return a string rather than a dataFrame.

Test Plan

Fixing tutorial docs

Diff Detail

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

Event Timeline

yichendai added a reviewer: yuhan.
  • Replace custom_types_figure_one image to highlight SimpleDataFrame
yichendai retitled this revision from Changed the title of Tutorials to Before We Start to Changed the Subtitle "Tutorials" to "Before We Start" and Replace a Image to Highlight the Concept "SimpleDataFrame" .Thu, Oct 1, 10:54 PM
yichendai edited the summary of this revision. (Show Details)
yichendai added a reviewer: max.
yichendai retitled this revision from Changed the Subtitle "Tutorials" to "Before We Start" and Replace a Image to Highlight the Concept "SimpleDataFrame" to Changed the Subtitle "Tutorials" to "Before We Start" and Replace a Image to Highlight the Concept "SimpleDataFrame".
  • Remind the user of add config to launch execution and update ERROR message for running custom_types_2.py
  1. Updating D4607: Changed the Subtitle "Tutorials" to "Before We Start" and Replace a Image to Highlight the Concept "SimpleDataFrame" #
  2. Enter a brief description of the changes included in this update.
  3. The first line is used as subject, next lines as comment. #
  4. If you intended to create a new revision, use: $ arc diff --create
yichendai retitled this revision from Changed the Subtitle "Tutorials" to "Before We Start" and Replace a Image to Highlight the Concept "SimpleDataFrame" to Fix Docs Small Bugs in Dagster Types Chapter.Fri, Oct 2, 12:50 AM
yichendai edited the summary of this revision. (Show Details)
yichendai edited the test plan for this revision. (Show Details)
  • Replace the previous img which displays unwanted keyboard shortcuts

Updating D4607: Fix Docs Small Bugs in Dagster Types Chapter

Replace previous img which includes unwanted keyboard shortcuts.

max requested changes to this revision.Fri, Oct 2, 12:46 PM

not sure why we're changing the names of these images

docs/next/src/pages/tutorial/testable.mdx
74 ↗(On Diff #23091)

i don't think this is helpful. either step through the process of running the pipeline with the new config, or assume that the reader understands it already.

104 ↗(On Diff #23091)

why are we changing the names of these images?

This revision now requires changes to proceed.Fri, Oct 2, 12:46 PM
  • Replace custom_types_figure_one image to highlight SimpleDataFrame
max requested changes to this revision.Fri, Oct 2, 5:43 PM
max added inline comments.
docs/next/public/assets/images/tutorial/custom_types_figure_one_simpleDataFrame.png
1

please replace the existing image (or delete)

This revision now requires changes to proceed.Fri, Oct 2, 5:43 PM
  • Replace custom_types_figure_one image to highlight SimpleDataFrame
  • Delete old image custom_types_figure_one