Page MenuHomePhabricator

Rewrote airline demo readme
ClosedPublic

Authored by nate on Aug 1 2019, 11:46 PM.

Details

Reviewers
max
Group Reviewers
Restricted Project
Commits
R1:f7cb9b801b45: Rewrote airline demo readme
Test Plan

docs only

Diff Detail

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

Event Timeline

nate created this revision.Aug 1 2019, 11:46 PM
nate added a reviewer: Restricted Project.Aug 1 2019, 11:50 PM

I'm worried by the amount of code in the readme - it can all go stale without noticing pretty easily. Not sure what alternative would be better.

examples/dagster_examples/airline_demo/README.md
74

whats this "!"?

156–159

"in practice" x2 - change up wording

422–423

on the papermill

'on papermill' ?

nate updated this revision to Diff 3379.Aug 2 2019, 7:46 PM
nate marked 3 inline comments as done.

comments and wrapping

nate added a comment.Aug 2 2019, 7:47 PM

yeah agree re: amount of code - but arguably true for the exposition, YAML, UI screenshots, etc. also.

Maybe best bet would be to reduce the surface area of this README? it covers a _ton_ of ground for one document...

examples/dagster_examples/airline_demo/README.md
74

must've been some non-printing unicode character, it appears as a space in my editor - seems to be fixable

156–159

fixed

422–423

sg!

spitting out ideas:

  • just cite where the code is instead of inlining it "you can see this in fn_name in file.py"
  • move the content in to comment blocks - maybe tag them and then refer to those tags in this readme
nate updated this revision to Diff 3434.Aug 6 2019, 4:38 PM

remove code blocks and replace w/ references

max added a subscriber: max.Aug 6 2019, 7:08 PM

I'd prefer to move this to docs/.rst and build the code in through the Sphinx build process -- then link to the docs from a very short README,md in the demo directory.

nate updated this revision to Diff 3474.Aug 6 2019, 10:43 PM

move to ReST

nate updated this revision to Diff 3476.Aug 6 2019, 10:50 PM

rebase

max accepted this revision.Aug 7 2019, 6:25 PM
This revision is now accepted and ready to land.Aug 7 2019, 6:25 PM
This revision was automatically updated to reflect the committed changes.