Skip to content

Commit 5149910

Browse files
authored
[dg] Eliminate 'component' in 'dg scaffold component' in dg docs as it is no longer valid (#29118)
## Summary & Motivation `dg scaffold component` no longer a command so changing it in the docs ## How I Tested These Changes Read ## Changelog NOCHANGELOG
1 parent 8f84cf3 commit 5149910

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

Diff for: docs/docs/guides/labs/components/building-pipelines-with-components/adding-components.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ Before adding a component, you must either [create a project with components](/g
2222
You can view the available component types in your environment by running the following command:
2323

2424
```bash
25-
dg list component-type
25+
dg list plugins --feature component
2626
```
2727

2828
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:
2929

3030
```bash
31-
dg docs component-type <component-name>
31+
dg docs
3232
```
3333

3434
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
3838
Once you've decided on the component type that you'd like to use, you can instantiate it by running:
3939

4040
```bash
41-
dg scaffold component <component-type> <component-name>
41+
dg scaffold <component-type> <component-path>
4242
```
4343

44-
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.
44+
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.
4545

4646
## Configuration
4747

@@ -55,7 +55,7 @@ The `component.yaml` is the primary configuration file for a component. It conta
5555
To see a sample `component.yaml` file for your specific component, you can run:
5656

5757
```bash
58-
dg docs component-type <component-name>
58+
dg docs
5959
```
6060

6161
### Component templating

Diff for: docs/docs/guides/labs/components/creating-new-component-types/creating-and-registering-a-component-type.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Now, you can use this component type to create new component instances.
101101

102102
## Configuring custom scaffolding
103103

104-
Once your component type is registered, instances of the component type can be scaffolded using the `dg scaffold component` command:
104+
Once your component type is registered, instances of the component type can be scaffolded using the `dg scaffold` command:
105105

106106
<CliInvocationExample path="docs_snippets/docs_snippets/guides/components/shell-script-component/4-scaffold-instance-of-component.txt" />
107107

@@ -115,7 +115,7 @@ In this case, we might want to scaffold a template shell script alongside a fill
115115
title="my_component_library/lib/shell_command.py"
116116
/>
117117

118-
Now, when we run `dg scaffold component`, we'll see that a template shell script is created alongside a filled-out `component.yaml` file:
118+
Now, when we run `dg scaffold`, we'll see that a template shell script is created alongside a filled-out `component.yaml` file:
119119

120120
<CodeExample
121121
path="docs_snippets/docs_snippets/guides/components/shell-script-component/5-scaffolded-component.yaml"

Diff for: js_modules/dagster-ui/packages/dg-docs-components/src/ComponentScaffolding.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import CopyButton from './CopyButton';
22
import styles from './css/ComponentScaffolding.module.css';
33

44
export default function ComponentScaffolding({componentName}: {componentName: string}) {
5-
const command = `dg scaffold component ${componentName} {component_name}`;
5+
const command = `dg scaffold ${componentName} {component_name}`;
66
return (
77
<div className={styles.container}>
88
<div>

Diff for: python_modules/libraries/dagster-sling/dagster_sling/components/sling_replication_collection/component.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ class SlingReplicationCollectionComponent(Component, Resolvable):
112112
[Sling](https://slingdata.io/) is a Powerful Data Integration tool enabling seamless ELT
113113
operations as well as quality checks across files, databases, and storage systems.
114114
115-
dg scaffold component dagster_sling.SlingReplicationCollectionComponent {component_name} to get started.
115+
dg scaffold dagster_sling.SlingReplicationCollectionComponent {component_path} to get started.
116116
117117
This will create a component.yaml as well as a `replication.yaml` which is a Sling-specific configuration
118118
file. See Sling's [documentation](https://docs.slingdata.io/concepts/replication#overview) on `replication.yaml`.

0 commit comments

Comments
 (0)