Skip to content
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

Add Automation Page #23659

Merged
merged 10 commits into from
Aug 16, 2024
Merged

Add Automation Page #23659

merged 10 commits into from
Aug 16, 2024

Conversation

PedramNavid
Copy link
Contributor

@PedramNavid PedramNavid commented Aug 14, 2024

This adds a "How to Automate Pipelines" guide. The idea behind this page is that it serves as the entry point for Automation. We explain the three ways to automate, each example offers links to a How-To guide with examples for that concept, and potentially a concept page. Not every idea needs a concept page. For example, Asset Sensors may only need a Guide and Reference API documentation.

I did not include the section on Declarative Automation, but it would also fall here.

Copy link

netlify bot commented Aug 14, 2024

Deploy Preview for dagsterapidocs canceled.

Name Link
🔨 Latest commit 242a28c
🔍 Latest deploy log https://app.netlify.com/sites/dagsterapidocs/deploys/66bece606c3ed00008a1bf32

Copy link

Deploy preview for dagit-core-storybook ready!

✅ Preview
https://dagit-core-storybook-1uaf0d9os-elementl.vercel.app
https://pdrm-add-automation.core-storybook.dagster-docs.io

Built with commit ff56dec.
This pull request is being automatically deployed with vercel-action

@PedramNavid PedramNavid marked this pull request as ready for review August 14, 2024 21:10
@graphite-app graphite-app bot requested a review from erinkcochran87 August 14, 2024 21:12
@graphite-app graphite-app bot added the area: docs Related to documentation in general label Aug 14, 2024
Copy link

github-actions bot commented Aug 14, 2024

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-ihiqwnbgj-elementl.vercel.app
https://pdrm-add-automation.dagster.dagster-docs.io

Direct link to changed pages:
docs/docs-next/docs/concepts/schedules

Copy link

github-actions bot commented Aug 14, 2024

Deploy preview for dagster-docs-next ready!

✅ Preview
https://dagster-docs-next-6j2qrwrxe-elementl.vercel.app

Built with commit 242a28c.
This pull request is being automatically deployed with vercel-action

Copy link
Contributor

@erinkcochran87 erinkcochran87 left a comment

Choose a reason for hiding this comment

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

Overall I think this is good. I'm a little curious what the concept page for automation will look like, given how high-level this is. D'you think it may wind up being duplicative?

docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Outdated Show resolved Hide resolved
By understanding and effectively using these automation methods, you can build more efficient data pipelines that respond to your specific needs and constraints.
Copy link
Contributor

Choose a reason for hiding this comment

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

lol ty for removing this

docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Outdated Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
docs/docs-next/docs/guides/automation.md Show resolved Hide resolved
@PedramNavid
Copy link
Contributor Author

Overall I think this is good. I'm a little curious what the concept page for automation will look like, given how high-level this is. D'you think it may wind up being duplicative?

I was worried about that too. I've started writing it now so we'll have something to compare with.

I think the Concept/Explanation page will be more in-depth. I saw it described as 'bathtub-reading' which kind of makes sense. It will talk about things like ticks, the dagster-daemon, maybe a little history (e.g. Schedules were created during the Op era which is why they are focused around jobs and ops), some corner cases like daylight savings time, how to think about timezones.

My mental model, and I don't know how good it is, is that
--> I am working on a pipeline right now and I want to automate it, I go to this page
--> I have finished a long day of working on pipelines, and I want to relax with a beer and better understand Dagster's automation system (these people do exist!), I go to Concept Page.

@PedramNavid PedramNavid merged commit 4e1a1c9 into docs/revamp Aug 16, 2024
7 of 8 checks passed
@PedramNavid PedramNavid deleted the pdrm/add-automation branch August 16, 2024 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants