diff --git a/docs/docs-next/docs/partials/_InspirationList.md b/docs/docs-next/docs/partials/_InspirationList.md new file mode 100644 index 0000000000000..ba76d609c3c9a --- /dev/null +++ b/docs/docs-next/docs/partials/_InspirationList.md @@ -0,0 +1,7 @@ +## Want more inspiration? + +If you're looking for additional inspiration, we recommend: + +- [**Dagster Open Platform**](https://github.com/dagster-io/dagster-open-platform), which is Dagster Lab's open-source data platform. This full-sized project contains real assets and other Dagster features used by the Dagster Labs team. +- [**GitHub Discussions**](https://github.com/dagster-io/dagster/discussions), where you can ask questions and get inspired by the Dagster community +- [**The Awesome Dagster repository**](https://github.com/dagster-io/awesome-dagster), which is a collection of all awesome things related to Dagster, including other users' projects, talks, articles, and more \ No newline at end of file diff --git a/docs/docs-next/src/templates/concept.md b/docs/docs-next/src/templates/concept.md new file mode 100644 index 0000000000000..79f5b515a53a5 --- /dev/null +++ b/docs/docs-next/src/templates/concept.md @@ -0,0 +1,96 @@ +--- +title: "" +description: "" +--- + +# [TOPIC] + + + +--- + +## Benefits + + + +Using [TOPIC] helps you: + + + +--- + +## Prerequisites + + + +Before continuing, you should be familiar with: + + + +--- + +## How it works + + + +--- + +## Getting started + + + +Check out these guides to get started with [CONCEPT]: + +From here, you can: + + + +### Limitations [and notes] + + + +--- + +## Related + + \ No newline at end of file diff --git a/docs/docs-next/src/templates/example-reference.md b/docs/docs-next/src/templates/example-reference.md new file mode 100644 index 0000000000000..09f4df9301e20 --- /dev/null +++ b/docs/docs-next/src/templates/example-reference.md @@ -0,0 +1,44 @@ +--- +title: "[TOPIC] example reference" +description: "" +--- + +# [TOPIC] examples + +This reference contains a variety of examples using Dagster [TOPIC]. Each example contains: + +- A summary +- Additional notes +- Links to relevant documentation +- A list of the APIs used in the example + +--- + +## [Title of example] + +[This example demonstrates [description of what the example accomplishes] + + + +```python title="my_schedule.py" +@schedule(job=my_job, cron_schedule="* * * * *") +def logs_then_skips(context): + context.log.info("Logging from a schedule!") + return SkipReason("Nothing to do") +``` + + + +| | | +|-|-| +| Notes | | +| Related docs | | +| APIs in this example | | + +--- + + + +import InspirationList from '../partials/_InspirationList.md'; + + \ No newline at end of file diff --git a/docs/docs-next/src/templates/guide.md b/docs/docs-next/src/templates/guide.md new file mode 100644 index 0000000000000..ced99f32d16ff --- /dev/null +++ b/docs/docs-next/src/templates/guide.md @@ -0,0 +1,49 @@ +--- +title: "" +description: "" +--- + +# [Title that briefly describes what the guide is for] + + + +By the end of this guide, you will [a sentence or list about what will be achieved by the end of the guide]. + +--- + +## Prerequisites + + + +To follow the steps in this guide, you'll need: + +- A prerequisite, ex: "Familiarity with Asset definitions" +- Another prerequisite, ex: "To install library" +- One more + +--- + +## Step 1: Title that describes what this step will do {#step-1} + + + +### Step 1.1: Title that describes a substep {#step-1-1} + + + +--- + +## Step 2: Another step {#step-2} + +--- + +## Related + +[List of links to related content] \ No newline at end of file