[components][docs] Add components doc on moving definitions into components #27721
+770
−6
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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
benpankow
changed the title
benpankow
changed the title
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-ouwfj0qk6-elementl.vercel.app Direct link to changed pages: |
benpankow
force-pushed
the
benpankow/definitions-component-docs
branch
from
c88201e to
eabb2ea
Compare
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| <CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/migrating-definitions/4-scaffold.txt" /> | ||
|
|
||
|
|
||
| This creates a new folder in `my_existing_project/components/elt-definitions`, with a `component.yaml` file. This component is rather simple, it just points to a file which contains a `Definitions` object. |
There was a problem hiding this comment.
Replace 'simple' with more specific descriptive language like 'straightforward' or describe its single responsibility, as per style guide requirements
Spotted by Graphite Reviewer (based on CI logs)
Is this helpful? React 👍 or 👎 to let us know.
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
Adds some brief, tested docs which migrate existing definitions module into a component.
One snag I hit here is that relative imports are not possible in a component folder, so it becomes pretty tricky to migrate any submodule which has multiple files.
https://dagster-docs-eanwjgfbu-elementl.vercel.app/guides/preview/components/migrating-definitions
Test Plan
See rendered docs, new test.