Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 13, 2025

Conversation

benpankow
Copy link
Member

@benpankow benpankow commented Feb 6, 2025

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 vs existing docs

Copy link

github-actions bot commented Feb 6, 2025

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-ciyp76rio-elementl.vercel.app

Direct link to changed pages:

@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 3fd60d4 to 8562905 Compare February 7, 2025 16:43
@benpankow benpankow force-pushed the benpankow/docs-test-creating-component branch from d7e1c6f to 0713466 Compare February 7, 2025 16:43
@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 8562905 to 7c89080 Compare February 7, 2025 17:26
@benpankow benpankow force-pushed the benpankow/docs-test-creating-component branch 2 times, most recently from 1e41328 to 47b7086 Compare February 7, 2025 18:44
@benpankow benpankow force-pushed the benpankow/docs-cmd-option-to-output branch from 2ae1a99 to 101ddfb Compare February 7, 2025 18:44
@benpankow benpankow force-pushed the benpankow/docs-test-creating-component branch from 47b7086 to 81cc387 Compare February 7, 2025 18:44
Copy link
Collaborator

@smackesey smackesey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

legit

Base automatically changed from benpankow/docs-cmd-option-to-output to master February 13, 2025 16:37
@benpankow benpankow force-pushed the benpankow/docs-test-creating-component branch from 81cc387 to 13a3afe Compare February 13, 2025 16:52
@benpankow benpankow merged commit 2f1a0f3 into master Feb 13, 2025
6 of 7 checks passed
@benpankow benpankow deleted the benpankow/docs-test-creating-component branch February 13, 2025 17:15
braunjj pushed a commit that referenced this pull request Feb 14, 2025
… 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)
brentjericho pushed a commit to brentjericho/dagster that referenced this pull request Feb 21, 2025
… tutorial (dagster-io#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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants