Supply a "Cookbook" of Dagster examples

[mcallaway]

Use Case

While the Dagster documentation is good, there are so many possible use cases, the documentation can't possibly cover all of the possibilities. It would be useful to have a collection of working examples, hopefully supplied by both the community and Dagster, that demonstrate various capabilities.

Ideas of Implementation

Perhaps a GitHub "site" or a "readthedocs" site where people could submit pull requests to contribute. I suggest a python sphinx configuration using MyST Markdown in order to support a featureful experience, yet still allow simple markdown. MyST Markdown allows for the use of "directives" like reStructuredText, and plugins could allow for things like diagrams etc. This is a "nice to have" of course, just a collection of examples would be great.

Additional Info

---

Message from the maintainers:

Excited about this feature? Give it a :thumbsup:. We factor engagement into prioritization.

[sryza]

Thanks for the suggestion @mcallaway.

Currently, examples are spread across two separate sections of our docs site:

• Concepts pages, which contain "bottoms up" examples that demonstrate how to use particular features.
• Guides, which is pretty sparse right now, but aims to contain "top down" examples that demonstrate how to accomplish particular tasks.

I think the best way to add a cookbook entry right now is to add an entry to our "Guides" page. Here are the steps:

• Create a folder inside the docs snippets directory and put code there.
• Include any prose inside an ".mdx" doc in the docs guides directory. This supports an extended form of markdown that can have embedded code snippets.
• Link to it from the guides page.

If parts of this seem onerous, I'd be interested to hear your take. There's tooling we have in mind to make this easier, but curious if any bits stick out to you.