You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[examples] consolidate docs_beta_snippets and docs_snippets (#28771)
## Summary & Motivation
Closes DOC-898.
Consolidates the `examples/docs_beta_snippets/` and
`examples/docs_snippets` directory for improved maintainability and
organization.
## How I Tested These Changes
## Changelog
NOCHANGELOG
For more information on testing the CLI commands used in docs, see [the README in docs tests](../../examples/docs_beta_snippets/docs_beta_snippets_tests/snippet_checks/README.md).
253
+
For more information on testing the CLI commands used in docs, see [the README in docs tests](../../examples/docs_snippets/docs_snippets_tests/snippet_checks/README.md).
Copy file name to clipboardExpand all lines: docs/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ This is the home of the Dagster documentation. The documentation site is built u
8
8
9
9
-`./src` contains custom components, styles, themes, and layouts.
10
10
-`./docs/` contains documentation Markdown files.
11
-
-`/examples/docs_snippets/docs_snippets/` contains code examples for the documentation. Some code examples also live in `/examples/` and `/examples/docs_beta_snippets/docs_beta_snippets/`.
11
+
-`/examples/docs_snippets/docs_snippets/` contains code examples for the documentation. Some code examples also live in `/examples/` and `/examples/docs_snippets/docs_snippets/`.
12
12
13
13
The docs are organized into the following sections:
Copy file name to clipboardExpand all lines: docs/docs/dagster-plus/deployment/deployment-types/hybrid/kubernetes/setup.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -433,19 +433,19 @@ The units for CPU and memory resources are described [in this document](https://
433
433
434
434
The default behavior in Dagster+ is to create one pod for a run. Each asset targeted by that run is executed in subprocess within the pod. Use a job tag to request resources for this pod, which in turn makes those resources available to the targeted assets.
435
435
436
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_job.py" language="python" title="Request resources for a job" />
436
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_job.py" language="python" title="Request resources for a job" />
437
437
438
438
Another option is to launch a pod for each asset by telling Dagster to use the Kubernetes job executor. In this case, you can specify resources for each individual asset.
439
439
440
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_asset.py" language="python" title="Request resources for an asset" />
440
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_asset.py" language="python" title="Request resources for an asset" />
441
441
442
442
</TabItem>
443
443
444
444
<TabItem value="pipes" label="Resources if using kubernetes pipes">
445
445
446
446
Dagster can launch and manage existing Docker images as Kubernetes jobs using the [Dagster kubernetes pipes integration](/integrations/libraries/kubernetes). To request resources for these jobs by supplying the appropriate Kubernetes pod spec.
447
447
448
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_pipes.py" language="python" title="Request resources for a k8s pipes asset" />
448
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/hybrid/agents/kubernetes/resource_request_pipes.py" language="python" title="Request resources for a k8s pipes asset" />
Copy file name to clipboardExpand all lines: docs/docs/dagster-plus/deployment/deployment-types/serverless/runtime-environment.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ By default, Dagster+ Serverless will package your code as PEX files and deploys
17
17
18
18
You can add dependencies by including the corresponding Python libraries in your Dagster project's `setup.py` file. These should follow [PEP 508](https://peps.python.org/pep-0508/).
You can also use a tarball to install a dependency, such as if `pip` is unable to resolve a package using `dependency_links`. For example, `soda` and `soda-snowflake` provide tarballs that you can include in the `install_requires` section:
23
23
@@ -48,18 +48,18 @@ Python versions 3.9 through 3.12 are all supported for Serverless deployments. Y
48
48
<TabsgroupId="method">
49
49
<TabItemvalue="GitHub"label="GitHub">
50
50
In your `.github/workflows/deploy.yml` file, update the `PYTHON_VERSION` environment variable with your desired Python version:
51
-
<CodeExamplepath="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/github_python_version.yaml"language="yaml"title="Updating the Python version in deploy.yml" />
51
+
<CodeExamplepath="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/github_python_version.yaml"language="yaml"title="Updating the Python version in deploy.yml" />
52
52
53
53
</TabItem>
54
54
<TabItemvalue="GitLab"label="GitLab">
55
55
1. Open your `.gitlab-ci.yml` file. If your `.gitlab-ci.yml` contains an `include` with a link to a Dagster provided CI/CD template:
Follow the link and replace the contents of your `.gitlab-ci.yml` with the YAML document at the link address. Otherwise, continue to the next step.
59
59
60
60
3. Update the `PYTHON_VERSION` environment variable with your desired Python version
61
61
62
-
<CodeExamplepath="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/gitlab_python_version.yaml"language="yaml"title="Updating the Python version in .gitlab-ci.yml" />
62
+
<CodeExamplepath="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/gitlab_python_version.yaml"language="yaml"title="Updating the Python version in .gitlab-ci.yml" />
63
63
64
64
</TabItem>
65
65
<TabItemvalue="CLI"label="CLI">
@@ -101,7 +101,7 @@ Setting a custom base image isn't supported for GitLab CI/CD workflows out of th
101
101
<Tabs groupId="method">
102
102
<TabItem value="GitHub" label="GitHub">
103
103
In your `.github/workflows/deploy.yml` file, add the `SERVERLESS_BASE_IMAGE_TAG` environment variable and set it to the tag printed out in the previous step:
104
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/github_base_image.yaml" language="yaml" title="Setting a custom base image in deploy.yml" />
104
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/github_base_image.yaml" language="yaml" title="Setting a custom base image in deploy.yml" />
105
105
106
106
</TabItem>
107
107
@@ -132,7 +132,7 @@ To add data files to your deployment, use the [Data Files Support](https://setup
132
132
```
133
133
134
134
If you want to include the data folder, modify your `setup.py` to add the `package_data` line:
135
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/data_files_setup.py" language="Python" title="Loading data files in setup.py" />
135
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/data_files_setup.py" language="Python" title="Loading data files in setup.py" />
136
136
137
137
## Disable PEX deploys
138
138
@@ -141,18 +141,18 @@ You have the option to disable PEX-based deploys and deploy using a Docker image
141
141
<Tabs groupId="method">
142
142
<TabItem value="GitHub" label="GitHub">
143
143
In your `.github/workflows/deploy.yml` file, update the `ENABLE_FAST_DEPLOYS` environment variable to `false`:
144
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/github_disable_pex.yaml" language="yaml" title="Disable PEX deploys in deploy.yml" />
144
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/github_disable_pex.yaml" language="yaml" title="Disable PEX deploys in deploy.yml" />
145
145
146
146
</TabItem>
147
147
<TabItem value="GitLab" label="GitLab">
148
148
1. Open your `.gitlab-ci.yml` file. If your `.gitlab-ci.yml` contains an `include` with a link to a Dagster provided CI/CD template:
Follow the link and replace the contents of your `.gitlab-ci.yml` with the YAML document at the link address. Otherwise, continue to the next step.
152
152
153
153
3. Update the `DISABLE_FAST_DEPLOYS` variable to `true`
154
154
155
-
<CodeExample path="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/gitlab_disable_pex.yaml" language="yaml" title="Disable PEX deploys in .gitlab-ci.yml" />
155
+
<CodeExample path="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/gitlab_disable_pex.yaml" language="yaml" title="Disable PEX deploys in .gitlab-ci.yml" />
156
156
157
157
</TabItem>
158
158
<TabItem value="CLI" label="CLI">
@@ -186,7 +186,7 @@ Setting a custom base image isn't supported for GitLab CI/CD workflows out of th
186
186
<TabsgroupId="method">
187
187
<TabItemvalue="GitHub"label="GitHub">
188
188
In your `.github/workflows/deploy.yml` file, add the `SERVERLESS_BASE_IMAGE_TAG` environment variable and set it to the tag printed out in the previous step:
189
-
<CodeExamplepath="docs_beta_snippets/docs_beta_snippets/dagster-plus/deployment/serverless/runtime-environment/github_no_pex_custom_base_image.yaml"language="yaml"title="Setting a custom base image in `deploy.yml`" />
189
+
<CodeExamplepath="docs_snippets/docs_snippets/dagster-plus/deployment/serverless/runtime-environment/github_no_pex_custom_base_image.yaml"language="yaml"title="Setting a custom base image in `deploy.yml`" />
0 commit comments