From d55bbc6aba4413ae07a35ae74b4f33dacc66e574 Mon Sep 17 00:00:00 2001 From: Nick Schrock Date: Tue, 8 Apr 2025 16:46:41 -0400 Subject: [PATCH 1/3] [dg] Eliminate 'component' in 'dg scaffold component' in dg docs as it is no longer valid --- .../packages/dg-docs-components/src/ComponentScaffolding.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx b/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx index 8e01fcb27d8ab..411e0d5168b6d 100644 --- a/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx +++ b/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx @@ -1,8 +1,8 @@ import CopyButton from './CopyButton'; import styles from './css/ComponentScaffolding.module.css'; -export default function ComponentScaffolding({componentName}: {componentName: string}) { - const command = `dg scaffold component ${componentName} {component_name}`; +export default function ComponentScaffolding({ componentName }: { componentName: string }) { + const command = `dg scaffold ${componentName} {component_name}`; return (
From e1cdebbd50ed34c85d9448aaec4e0986e4c9c2b7 Mon Sep 17 00:00:00 2001 From: Nick Schrock Date: Tue, 8 Apr 2025 17:41:21 -0400 Subject: [PATCH 2/3] cp --- .../packages/dg-docs-components/src/ComponentScaffolding.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx b/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx index 411e0d5168b6d..34ca35fc4a3d8 100644 --- a/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx +++ b/js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx @@ -1,7 +1,7 @@ import CopyButton from './CopyButton'; import styles from './css/ComponentScaffolding.module.css'; -export default function ComponentScaffolding({ componentName }: { componentName: string }) { +export default function ComponentScaffolding({componentName}: {componentName: string}) { const command = `dg scaffold ${componentName} {component_name}`; return (
From 93c15ed8e475077fe0ac1b24ee7cb50cd5af1a5f Mon Sep 17 00:00:00 2001 From: Nick Schrock Date: Wed, 9 Apr 2025 03:29:18 -0400 Subject: [PATCH 3/3] [dg] Update docs to no longer refer to 'dg project scaffold' (#29119) ## Summary & Motivation Update documentation to no longer refer to `dg scaffold component` ## How I Tested These Changes Read ## Changelog NOCHANGELOG --- .../adding-components.md | 10 +++++----- .../creating-and-registering-a-component-type.md | 4 ++-- .../sling_replication_collection/component.py | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/guides/labs/components/building-pipelines-with-components/adding-components.md b/docs/docs/guides/labs/components/building-pipelines-with-components/adding-components.md index b569d470d9021..af630e32a92f4 100644 --- a/docs/docs/guides/labs/components/building-pipelines-with-components/adding-components.md +++ b/docs/docs/guides/labs/components/building-pipelines-with-components/adding-components.md @@ -22,13 +22,13 @@ Before adding a component, you must either [create a project with components](/g You can view the available component types in your environment by running the following command: ```bash -dg list component-type +dg list plugins --feature component ``` This will display a list of all the component types that are available in your project. To see more information about a specific component type, you can run: ```bash -dg docs component-type +dg docs ``` This will display a webpage containing documentation for the specified component type. @@ -38,10 +38,10 @@ This will display a webpage containing documentation for the specified component Once you've decided on the component type that you'd like to use, you can instantiate it by running: ```bash -dg scaffold component +dg scaffold ``` -This will create a new directory inside your `components/` folder that contains a `component.yaml` file. Some component types may also generate additional files as needed. +This will create a new directory inside your `defs/` folder that contains a `component.yaml` file. Some component types may also generate additional files as needed. ## Configuration @@ -55,7 +55,7 @@ The `component.yaml` is the primary configuration file for a component. It conta To see a sample `component.yaml` file for your specific component, you can run: ```bash -dg docs component-type +dg docs ``` ### Component templating diff --git a/docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md b/docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md index f335f8726d549..84883a2771d73 100644 --- a/docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md +++ b/docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md @@ -101,7 +101,7 @@ Now, you can use this component type to create new component instances. ## Configuring custom scaffolding -Once your component type is registered, instances of the component type can be scaffolded using the `dg scaffold component` command: +Once your component type is registered, instances of the component type can be scaffolded using the `dg scaffold` command: @@ -115,7 +115,7 @@ In this case, we might want to scaffold a template shell script alongside a fill title="my_component_library/lib/shell_command.py" /> -Now, when we run `dg scaffold component`, we'll see that a template shell script is created alongside a filled-out `component.yaml` file: +Now, when we run `dg scaffold`, we'll see that a template shell script is created alongside a filled-out `component.yaml` file: