Page MenuHomePhabricator

[Docs] Corrected the path to fan_in_fan_out.py
ClosedPublic

Authored by yichendai on Thu, Oct 29, 7:09 PM.

Details

Summary

Fix the link of an example causing page not found error in Docs Examples Fan-In Dependency issue #3160

#3160

Test Plan

test_fan_in_fan_out_pipeline.py; test <VersionedGithubLink filePath="examples/fan_in_pipeline/" word="here" /> in local dev mode to check relative path

Diff Detail

Repository
R1 dagster
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

yichendai retitled this revision from Corrected the path to fan_in_fan_out.py to [Docs] Corrected the path to fan_in_fan_out.py.Thu, Oct 29, 7:12 PM
yichendai edited the summary of this revision. (Show Details)

will defer this to @sashank

not sure if we want to guide users to code inside dagster-test. we could maybe move the fan_in_fan_out.py to the examples/fan_in_pipeline - but then we should probably drop it from https://dagster.phacility.com/source/dagster/browse/master/js_modules/dagit/src/testing/SVGMocks.ts$45 - this is used for generating dagit mock too

im unclear on the nuances here, defer to yuhan and sashank

+1 on not linking to code in dagster-test. We should instead link to code in docs_snippets.

sashank requested changes to this revision.Tue, Nov 3, 8:50 PM
This revision now requires changes to proceed.Tue, Nov 3, 8:50 PM

Sorry about the wrong suggestion above, we should link to examples/fan_in_pipeline, not docs_snippets or dagster_test

Add test_fan_in_fan_out_pipeline.py; drop fan_in_fan_out from dagster/js_modules/dagit/src/testing/SVGMocks.ts

Fix lint error but still WIP (forgot to fix mdx meanwhile)

Fix the path in mdx file. It should be good after push.
However, the path provided in this quick fix won't allow us to preview the page in dev mode since the new fan_in_fan_out file hasn't been up onto github.
Can be optimized by providing a relative path later.

docs/next/src/pages/examples/fan_in_pipeline.mdx
22–25

The relative path doesn't work.

[here](../../../../../examples/fan_in_pipeline/fan_in_fan_out.py)

In mdx documentation, it seems it only supports link a file via relative path under src/pages. And idea? @sashank

A workaround is to land the fan_in_fan_out.py on master with a new diff first; then fix the mdx docs.

docs/next/src/pages/examples/fan_in_pipeline.mdx
22–25
<VersionedGithubLink filePath="examples/fan_in_pipeline/fan_in_fan_out.py" word="here" />

should work

Use a reusable component for relative path

This revision is now accepted and ready to land.Fri, Nov 13, 9:27 PM