[dg docs] Add docs e2e test, screenshot generation for component type tutorial (#27633)

## Summary

Noticed these docs are already(!) out of date (uses generate instead of
scaffold verbiage, `.resolve_params` instead of `.resolve`), so added a
brief test. Also played with some screenshot generation.

Didn't touch the last section on advanced custom resolution because the
code snippets are pretty pseudocode-y, bonus points if someone wants to
put that under test.

## Test Plan

See [new
docs](https://dagster-docs-agnb11wv4-elementl.vercel.app/guides/preview/components/creating-a-component)
vs [existing
docs](https://docs.dagster.io/guides/preview/components/creating-a-component)

Author: benpankow

docs/docs-beta/src/code-examples-content.js

@@ -1,5 +1,5 @@
 ---
-title: 'Creating a New Component Type'
+title: 'Creating a new component type'
 sidebar_position: 100
 ---
 
@@ -36,13 +36,11 @@ For this example, we'll write a lightweight component that executes a shell comm
 
 First, we use the `dg` command-line utility to scaffold a new component type:
 
-```bash
-dg component-type generate shell_command
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/1-dg-scaffold-shell-command.txt" />
 
 This will add a new file to your project in the `lib` directory:
 
-<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/empty.py" language="python" />
+<CodeExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/2-shell-command-empty.py" language="python" title="my_component_library/lib/shell_command.py" />
 
 This file contains the basic structure for the new component type. There are two methods that you'll need to implement:
 
@@ -92,18 +90,15 @@ Our `build_defs` method will create a single `@asset` that executes the provided
 
 Following the steps above will automatically register your component type in your environment. You can now run:
 
-```bash
-dg component-type list
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt" />
 
 and see your new component type in the list of available component types.
 
 You can also view automatically generated documentation describing your new component type by running:
 
-```bash
-dg component-type docs your_library.shell_command
-```
+<CliInvocationExample path="docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/4-dg-component-type-docs.txt" />
 
+![](/images/guides/build/projects-and-components/components/component-type-docs.png)
 ## [Advanced] Custom templating
 
 The components system supports a rich templating syntax that allows you to load arbitrary Python values based off of your `component.yaml` file. All string values in a `ResolvableModel` can be templated using the Jinja2 templating engine, and may be resolved into arbitrary Python types. This allows you to expose complex object types, such as `PartitionsDefinition` or `AutomationCondition` to users of your component, even if they're working in pure YAML.
@@ -126,4 +121,4 @@ params:
 
 ## Next steps
 
-- Add a new component to your project
+- [Add a new component to your project](./using-a-component.md)

docs/docs/guides/preview/components/creating-a-component.md

@@ -0,0 +1,4 @@
+dg component-type scaffold shell_command
+
+Creating a Dagster component type at /.../my-component-library/my_component_library/lib/shell_command.py.
+Scaffolded files for Dagster project in /.../my-component-library/my_component_library/lib.

docs/static/images/guides/build/projects-and-components/components/component-type-docs.png

@@ -0,0 +1,30 @@
+from dagster import Definitions
+from dagster_components import (
+    Component,
+    ComponentLoadContext,
+    DefaultComponentScaffolder,
+    ResolvableSchema,
+    registered_component_type,
+)
+
+class ShellCommandSchema(ResolvableSchema):
+    ...
+
+@registered_component_type(name="shell_command")
+class ShellCommand(Component):
+    """COMPONENT SUMMARY HERE.
+
+    COMPONENT DESCRIPTION HERE.
+    """
+
+    @classmethod
+    def get_schema(cls):
+        return ShellCommandSchema
+
+    @classmethod
+    def get_scaffolder(cls) -> DefaultComponentScaffolder:
+        return DefaultComponentScaffolder()
+
+    def build_defs(self, load_context: ComponentLoadContext) -> Definitions:
+        # Add definition construction logic here.
+        return Definitions()

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/1-dg-scaffold-shell-command.txt

@@ -0,0 +1,15 @@
+dg component-type list
+
+Using /.../my-component-library/.venv/bin/dagster-components
+┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Component Type                                        ┃ Summary                        ┃
+┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ definitions@dagster_components                        │ Wraps an arbitrary set of      │
+│                                                       │ Dagster definitions.           │
+│ pipes_subprocess_script_collection@dagster_components │ Assets that wrap Python        │
+│                                                       │ scripts executed with          │
+│                                                       │ Dagster's                      │
+│                                                       │ PipesSubprocessClient.         │
+│ shell_command@my_component_library                    │ Models a shell script as a     │
+│                                                       │ Dagster asset.                 │
+└───────────────────────────────────────────────────────┴────────────────────────────────┘

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/2-shell-command-empty.py

@@ -0,0 +1 @@
+dg component-type docs shell_command@my_component_library

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/3-dg-list-component-types.txt

@@ -0,0 +1,37 @@
+
+    <!DOCTYPE html>
+    <html lang="en">
+    <head>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <title>Markdown Preview</title>
+    </head>
+    <body>
+        <h2>Component: <code>my_component_library.shell_command</code></h2>
+<h3>Description:</h3>
+<p>Models a shell script as a Dagster asset.</p>
+<h3>Sample Component Params:</h3>
+<textarea rows=21 cols=100>
+type: my_component_library.shell_command
+
+params:
+  script_path: '...'
+  asset_specs:
+    - deps:
+        - '...'
+      description: '...'
+      metadata: '...'
+      group_name: '...'
+      skippable: false
+      code_version: '...'
+      owners:
+        - '...'
+      tags: '...'
+      kinds:
+        - '...'
+      automation_condition: '...'
+      key: '...'
+
+</textarea>
+    </body>
+    </html>

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/4-dg-component-type-docs.txt

@@ -0,0 +1,3 @@
+type: shell_command@my_component_library
+
+params: {}

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/5-dg-component-type-docs.html

@@ -31,6 +31,8 @@ def resolve_asset_specs(
 @registered_component_type(name="shell_command")
 @dataclass
 class ShellCommand(Component):
+    """Models a shell script as a Dagster asset."""
+
     script_path: str
     asset_specs: Annotated[Sequence[dg.AssetSpec], FieldResolver(resolve_asset_specs)]
 
@@ -39,11 +41,13 @@ def get_schema(cls) -> type[ShellScriptSchema]:
         return ShellScriptSchema
 
     def build_defs(self, load_context: ComponentLoadContext) -> dg.Definitions:
+        resolved_script_path = Path(load_context.path, self.script_path).absolute()
+
         @dg.multi_asset(name=Path(self.script_path).stem, specs=self.asset_specs)
         def _asset(context: dg.AssetExecutionContext):
-            self.execute(context)
+            self.execute(resolved_script_path, context)
 
         return dg.Definitions(assets=[_asset])
 
-    def execute(self, context: dg.AssetExecutionContext):
-        subprocess.run(["sh", self.script_path], check=True)
+    def execute(self, resolved_script_path: Path, context: dg.AssetExecutionContext):
+        subprocess.run(["sh", str(resolved_script_path)], check=True)

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/6-scaffolded-component.yaml

@@ -18,6 +18,8 @@ class ShellScriptSchema(ResolvableSchema):
 
 @registered_component_type(name="shell_command")
 class ShellCommand(Component):
+    """Models a shell script as a Dagster asset."""
+
     @classmethod
     def get_schema(cls) -> type[ShellScriptSchema]:
         return ShellScriptSchema

examples/docs_beta_snippets/docs_beta_snippets/guides/components/shell-script-component/with-build-defs.py

@@ -1,3 +1,5 @@
+from collections.abc import Iterator
+
 import pytest
 
 
@@ -11,3 +13,23 @@ def pytest_addoption(parser: pytest.Parser) -> None:
 @pytest.fixture
 def update_snippets(request: pytest.FixtureRequest) -> bool:
     return bool(request.config.getoption("--update-snippets"))
+
+
+@pytest.fixture(scope="session")
+def get_selenium_driver():
+    from selenium import webdriver
+
+    driver = None
+
+    try:
+
+        def _get_driver():
+            nonlocal driver
+            if driver is None:
+                driver = webdriver.Chrome()
+            return driver
+
+        yield _get_driver
+    finally:
+        if driver:
+            driver.quit()