Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/.vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,22 @@ StylesPath = "vale/styles"
MinAlertLevel = suggestion
Vocab = Dagster

Packages = write-good

########################
# FORMAT ASSOCIATIONS #
########################

[formats]
#[formats]
mdx = md

########################
# FORMAT-SPECIFIC #
########################

[*.{md,mdx,rst}]
BasedOnStyles = Dagster, Terms, Vale
[*.{md,rst}]
; BasedOnStyles = Dagster, Terms, Vale, write-good
BasedOnStyles = Terms, Dagster

; References:
; - https://vale.sh/docs/topics/scoping/#non-standard-markup
Expand Down Expand Up @@ -55,4 +58,5 @@ TokenIgnores = (`[^`]*`), \
(<\/?TabItem.*>), \
(<\/?Tabs.*>), \
(</?details>), \
(<CodeExample(\n.*)+\/>), \
(<summary>.*<\/summary>)
6 changes: 3 additions & 3 deletions docs/docs/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ make dev_webapp

During development, you might find these commands useful. Run them from `js_modules/dagster-ui`:

- `make ts`: Typescript typechecking
- `make ts`: TypeScript typechecking
- `make lint`: Linting with autofix
- `make jest`: Test runner that runs the full suite of tests

Expand Down Expand Up @@ -150,7 +150,7 @@ For the full guidelines for writing and debugging documentation, please refer to

## Picking a GitHub Issue

We encourage you to start with an issue labeled with the tag [`good first issue`](https://github.com/dagster-io/dagster/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+good+first+issue%22) on the [Github issue board](https://github.com/dagster-io/dagster/issues), to get familiar with our codebase as a first-time contributor.
We encourage you to start with an issue labeled with the tag [`good first issue`](https://github.com/dagster-io/dagster/issues?q=is%3Aopen+is%3Aissue+label%3A%22type%3A+good+first+issue%22) on the [GitHub issue board](https://github.com/dagster-io/dagster/issues), to get familiar with our codebase as a first-time contributor.

When you are ready for more of a challenge, you can tackle issues with the [most 👍 reactions](https://github.com/dagster-io/dagster/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc). We factor engagement into prioritization of the issues. You can also explore other labels and pick any issue based on your interest.

Expand All @@ -162,4 +162,4 @@ In the PR template, please describe the change, including the motivation/context

A Core reviewer will review your PR in around one business day and provide feedback on any changes it requires to be approved. Once approved and all the tests (including Buildkite!) pass, the reviewer will click the Squash and merge button in GitHub 🥳.

Your PR is now merged into Dagster! Well shout out your contribution in the weekly release notes.
Your PR is now merged into Dagster! We'll shout out your contribution in the weekly release notes.
2 changes: 1 addition & 1 deletion docs/docs/about/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Backend telemetry collection is logged at `$DAGSTER_HOME/logs/` if `$DAGSTER_HOM

Use of telemetry data is governed by the [Dagster Privacy Policy](https://dagster.io/privacy).

If youd like to opt out, you can add the following to `$DAGSTER_HOME/dagster.yaml` (creating that file if necessary):
If you'd like to opt out, you can add the following to `$DAGSTER_HOME/dagster.yaml` (creating that file if necessary):

```yaml
telemetry:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api/clis/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**/*.mdx
!index.mdx
!index.md
2 changes: 1 addition & 1 deletion docs/docs/api/clis/dg-cli/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**/*.mdx
!dg-cli-configuration.mdx
!dg-cli-configuration.md
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/api/dagster/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**/*.mdx
!index.mdx
!index.md
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/api/graphql/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**/*.mdx
!index.mdx
!index.md
2 changes: 1 addition & 1 deletion docs/docs/api/graphql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Clicking on the **Docs** tab on the right edge of the playground opens up intera

## Python client

Dagster also provides a Python client to interface with Dagster's GraphQL API from Python. For more information, see "[Dagster Python GraphQL client](/api/graphql/graphql-client)".
Dagster also provides a Python client to interface with Dagster's GraphQL API from Python. For more information, see [Dagster Python GraphQL client](/api/graphql/graphql-client).

## Example queries

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/docs/api/rest-apis/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
**/*.mdx
!external-assets-rest-api.mdx
!external-assets-rest-api.md
4 changes: 2 additions & 2 deletions docs/docs/dagster-basics-tutorial/0-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,12 @@ Use the following command to launch the Dagster UI locally:

Then, in a browser, navigate to [http://127.0.0.1:3000](http://127.0.0.1:3000).

At this point, your project will be empty, but youll continue adding to it throughout the tutorial.
At this point, your project will be empty, but you'll continue adding to it throughout the tutorial.

![2048 resolution](/images/tutorial/dagster-tutorial/project.png)

:::tip

As you develop with Dagster, its often useful to periodically run `dg dev` to view your project.
As you develop with Dagster, it's often useful to periodically run `dg dev` to view your project.

:::
2 changes: 1 addition & 1 deletion docs/docs/dagster-basics-tutorial/1-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For now, these assets will simply represent the underlying files. Next, we will

## 3. Check definitions

In Dagster, all defined objects (such as assets) need to be associated with a top-level <PyObject section="definitions" module="dagster" object="Definitions" /> object in order to be deployed. When you first created your project with `uvx create-dagster project`, a `definitions.py` file was also created:
In Dagster, all defined objects (such as assets) need to be associated with a top-level <PyObject section="definitions" module="dagster" object="Definitions" /> object to be deployed. When you first created your project with `uvx create-dagster project`, a `definitions.py` file was also created:

<CodeExample
path="docs_snippets/docs_snippets/guides/tutorials/dagster_tutorial/src/dagster_tutorial/definitions.py"
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/dagster-basics-tutorial/4-asset-checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Asset checks run automatically when an asset is materialized, but you can also e

1. Navigate to **Assets**.
2. Click **Reload definitions**.
3. Navigate to the **Asset Details** page for the `orders_aggregation` asset.
3. Navigate to the **asset details** page for the `orders_aggregation` asset.
4. Select the **Checks** tab.
5. Click **Execute** for `orders_aggregation`.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/dagster-basics-tutorial/6-custom-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If we think about the code for our three assets (`customers`, `orders`, and `pay

These assets are a great candidate for a [custom component](/guides/build/components/creating-new-components). Components generate `Definitions` through a configuration layer. There are built-in components that let you integrate with common workflows (such as turning Python scripts into assets), or dynamically generate `Definitions` for tools like [dbt](/integrations/libraries/dbt) or [Fivetran](/integrations/libraries/fivetran). With custom components, you can define your own specific use cases.

In this step, you will use a custom component to streamline the development of similar assets and replace their `Definitions` in your project with a Component that can generate them from a a YAML configuration file instead.
In this step, you will use a custom component to streamline the development of similar assets and replace their `Definitions` in your project with a Component that can generate them from a YAML configuration file instead.

![2048 resolution](/images/tutorial/dagster-tutorial/overviews/components.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/dagster-basics-tutorial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ By the end, you will be ready to build your own data pipelines and explore more

## Dagster's programming model

Dagsters programming model is built around `Assets`, which are organized within `Definitions`.
Dagster's programming model is built around `Assets`, which are organized within `Definitions`.

- **`Definitions`** act as containers for all Dagster entities in your project.

- **`Assets`** are the core building blocks of Dagster. They represent the entities in your data platform, while the dependencies between them define the projects lineage.
- **`Assets`** are the core building blocks of Dagster. They represent the entities in your data platform, while the dependencies between them define the project's lineage.

![2048 resolution](/images/tutorial/dagster-tutorial/overviews/overview-1.png)

If youd like to learn about the full set of Dagster features and how they interact with each other, check out our [Concepts page](/getting-started/concepts).
If you'd like to learn about the full set of Dagster features and how they interact with each other, check out our [Concepts page](/getting-started/concepts).

## Prerequisites

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For example, the **Admin** user role includes permissions specific to this role

:::tip Teams in Dagster+ Pro

Dagster+ Pro users can create teams of users and assign default permission sets. For more information, see "[Managing teams in Dagster+](/deployment/dagster-plus/authentication-and-access-control/rbac/teams)".
Dagster+ Pro users can create teams of users and assign default permission sets. For more information, see [Managing teams in Dagster+](/deployment/dagster-plus/authentication-and-access-control/rbac/teams).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ By default, users will be granted Viewer permissions on each deployment. The def
5. In the **User email** field, enter the user's email address.
6. Click **Add user**.

After the user is created, they will be notified via email, and you can [add the user to teams](#teams) and [assign user roles for each deployment](#user-roles).
After the user is created, they will be notified by email, and you can [add the user to teams](#teams) and [assign user roles for each deployment](#user-roles).

![Screenshot of assigning roles to a user](/images/dagster-plus/features/authentication-and-access-control/adding-new-user.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ BRANCH_DEPLOYMENT_NAME=$(
--branch-name $BRANCH_NAME \
--commit-hash $COMMIT_SHA \
--timestamp $TIMESTAMP
--code-review-url $PR_URL \ # URL to review the given changes, e.g.
--code-review-url $PR_URL \ # URL to review the given changes, for example
# Pull Request or Merge Request
--code-review-id $INPUT_PR \ # Alphanumeric ID for the given set of changes
--pull-request-status $PR_STATUS \ # A status, one of `OPEN`, `CLOSED`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To complete the steps in this guide, you'll need:
- A Dagster+ account
- An empty Dagster project created with the `create-dagster project` CLI. For more information, see [Creating Dagster projects](/guides/build/projects/creating-projects).
- An existing [branch deployments setup](/deployment/dagster-plus/deploying-code/branch-deployments/configuring-branch-deployments) in the project that uses GitHub actions or GitLab CI/CD. Your setup should contain the following files:
- Either a GitHub actions workflow file (e.g. `.github/workflows/dagster-plus-deploy.yml` (Serverless) or `dagster-cloud-deploy.yml` (Hybrid)) or a GitLab CI/CD file (e.g. `.gitlab-ci.yml`)
- Either a GitHub actions workflow file (such as `.github/workflows/dagster-plus-deploy.yml` (Serverless) or `dagster-cloud-deploy.yml` (Hybrid)) or a GitLab CI/CD file (such as`.gitlab-ci.yml`)
- A Dockerfile that installs your Dagster project (Dagster+ Hybrid only)
- User permissions in Dagster+ that allow you to [access branch deployments](/deployment/dagster-plus/authentication-and-access-control/rbac/user-roles-permissions)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ During the deployment, the agent will attempt to load your code and update the m
- Optionally update the variable type, environments, visibility, flags, and description fields as needed.
- Click **Add variable**.

After following these steps, commiting and pushing additional changes to your Dagster project in GitLab will deploy them to your Dagster+ organization.
After following these steps, when you commit and push additional changes to your Dagster project in GitLab, the changes will be deployed to your Dagster+ organization.

## Other Git providers or local Git repository

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Full deployments
sidebar_position: 10
description: Dagster+ full deployments are persistent, fully-featured deployments intended to run pipelines on a recurring basis.
description: Dagster+ full deployments are persistent, fully featured deployments intended to run pipelines on a recurring basis.
canonicalUrl: '/deployment/dagster-plus/deploying-code/full-deployments'
slug: '/deployment/dagster-plus/deploying-code/full-deployments'
tags: [dagster-plus-feature]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Each full deployment can have one or multiple [code locations](/guides/build/pro
In Dagster+, there are two types of deployments:

- [**Branch deployments**](/deployment/dagster-plus/deploying-code/branch-deployments), which are temporary deployments built for testing purposes. We recommend using branch deployments to test your changes, even if you're able to create additional deployments. Branch deployments are available for all Dagster+ users, regardless of plan.
- **Full deployments**, which are persistent, fully-featured deployments intended to perform actions on a recurring basis. This guide focuses on full deployments.
- **Full deployments**, which are persistent, fully featured deployments intended to perform actions on a recurring basis. This guide focuses on full deployments.

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/deployment/dagster-plus/deploying-code/index.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Deploying code to Dagster+
sidebar_position: 600
description: When deploying code to Dagster+, you can create persistent, fully-featured full deployments, set up CI/CD to continuously deploy from a Git repo, and configure branch deployments to create ephemeral preview deployments of your Dagster code in Git branches.
description: When deploying code to Dagster+, you can create persistent, fully featured full deployments, set up CI/CD to continuously deploy from a Git repo, and configure branch deployments to create ephemeral preview deployments of your Dagster code in Git branches.
tags: [dagster-plus-feature]
canonicalUrl: '/deployment/dagster-plus/deploying-code'
slug: '/deployment/dagster-plus/deploying-code'
---

When deploying code to Dagster+, you can do the following:

- Create [full deployments](/deployment/dagster-plus/deploying-code/full-deployments), which are persistent, fully-featured deployments intended to run pipelines on a recurring basis (for example, persistent staging and dev environments).
- Create [full deployments](/deployment/dagster-plus/deploying-code/full-deployments), which are persistent, fully featured deployments intended to run pipelines on a recurring basis (for example, persistent staging and dev environments).
- Set up [CI/CD](/deployment/dagster-plus/deploying-code/configuring-ci-cd) to continuously deploy code from a Git repository on push to the main branch.
- Set up [branch deployments](/deployment/dagster-plus/deploying-code/branch-deployments), which create ephemeral preview deployments of your Dagster code in Git branches, right in Dagster+, every time you create a branch and open a pull or merge request.
Loading