[components] Deployment directory doc #27360
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| This is the default set of component types available in every new code | ||
| location. We can add to it by installing `dagster-components[dbt]`: |
There was a problem hiding this comment.
There appears to be a mismatch between the text and the example command. The text mentions installing dagster-components[dbt], but the subsequent command shows dagster-components[sling]. Consider updating the text to match the actual package being installed.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
| @@ -0,0 +1,152 @@ | |||
| --- | |||
| title: "Adding a component to a project" | |||
There was a problem hiding this comment.
The document title "Adding a component to a project" doesn't accurately reflect the content, which focuses on creating and managing deployment directories with multiple code locations. A more fitting title would be "Setting up a deployment directory" to help readers quickly understand the document's purpose.
Spotted by Graphite Reviewer
Is this helpful? React 👍 or 👎 to let us know.
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-8is3ryz8r-elementl.vercel.app Direct link to changed pages: |
smackesey
force-pushed
the
sean/components/deployment-doc
branch
from
0c327da to
d95ef28
Compare
smackesey
force-pushed
the
sean/components/deployment-doc
branch
2 times, most recently
from
e398562 to
1d7d0ff
Compare
| ### pyproject.toml | ||
|
|
||
| [tool.dg] | ||
| is_deployment = true |
There was a problem hiding this comment.
recommend making this a type or enum to future proof
There was a problem hiding this comment.
Making what an enum exactly? The values of all config params are checked at load time
There was a problem hiding this comment.
Meaning that I don't think we should have a is_deployment=true flag in here and instead of project_type= or something
There was a problem hiding this comment.
Problem with that is there are currently three is_* flags you can set and two of them can coexist:
is_deploymentis_code_locationis_component_lib
is_component_lib and is_code_location can coexist.
| $ cd code_locations/code-location-1 && dg component-type list | ||
|
|
||
| dagster_components.definitions | ||
| dagster_components.pipes_subprocess_script_collection | ||
| Assets that wrap Python scripts executed with Dagster's PipesSubprocessClient. |
There was a problem hiding this comment.
we definitely need to improve this output :-) cc: @benpankow
There was a problem hiding this comment.
Linear task for this, we can leverage rich (which typer uses): https://linear.app/dagster-labs/issue/BUILD-637/generate-a-table-output-for-dg-component-type-list
|
|
||
| As you can see, we are back to only the default list of component types. This | ||
| is because we are now using the environment of `code-location-2`, in which we | ||
| have not installed `dagster-components[sling]`. |
There was a problem hiding this comment.
demonstrate a final command of running dagster dev and having it run the two code servers
| ### pyproject.toml | ||
|
|
||
| [tool.dg] | ||
| is_deployment = true |
There was a problem hiding this comment.
Meaning that I don't think we should have a is_deployment=true flag in here and instead of project_type= or something
smackesey
force-pushed
the
sean/components/deployment-doc
branch
from
1d7d0ff to
66eda58
Compare
Summary & Motivation
New doc that shows how to create a multi-code-location deployment directory with
dgand demonstrates the separation of environments between code locations.How I Tested These Changes
Manually went through the demonstrated flow.