Skip to content

Commit

Permalink
DOC - Clean up images directories (#27222)
Browse files Browse the repository at this point in the history
## Summary & Motivation

The screenshot folders now match the organizational structure of the
docs.

## How I Tested These Changes

Ran locally and found no broken llinks
  • Loading branch information
C00ldudeNoonan authored Jan 22, 2025
1 parent 0b5f237 commit 0d727d6
Show file tree
Hide file tree
Showing 103 changed files with 120 additions and 83 deletions.
2 changes: 1 addition & 1 deletion docs/docs-beta/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Images are located in [/docs/docs-beta/static/images](https://github.com/dagster
#### Formatting

```
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-plus/deployment/code-locations/redeploy-code-location.png)
```

### Notes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,19 @@ Before continuing, you should be familiar with:
1. In the Dagster+ UI, navigate to the **Deployment** tab.
2. In the row associated with the code location you're interested in, click **View history** in the **Updated** column.

![Screenshot highlighting the "Updated" column for a code location](/images/dagster-plus/code-locations/view-code-location-history.png)
![Screenshot highlighting the "Updated" column for a code location](/images/dagster-plus/deployment/code-locations/view-code-location-history.png)

This will bring up a modal showing a history of every time that code location has been loaded, and metadata associated with that load. If you have connected Dagster+ to a GitHub or GitLab repository, each row will have a link to the commit that was deployed at that point in time.

If a code location has been deployed multiple times with identical metadata, these rows will be collapsed together. You can expand them by deselecting **Collapse similar entries** in the top left corner of the modal.

This metadata will also include information regarding assets that have been **added**, **removed**, or **changed**. In the **Assets** column, you can see the keys of assets in any of these categories.

![Screenshot highlighting the column that displays these keys](/images/dagster-plus/code-locations/code-location-history-metadata.png)
![Screenshot highlighting the column that displays these keys](/images/dagster-plus/deployment/code-locations/code-location-history-metadata.png)

Currently, changes to **code version**, **tags**, **metadata**, **dependencies** and **partitions definition** are tracked. Clicking on any of these assets brings you to its **Asset details** page. Here, you can find the **Change history** tab, and see detailed information regarding each time the asset definition has changed.

![Screenshot highlighting the Change History tab for an asset](/images/dagster-plus/code-locations/asset-change-history.png)
![Screenshot highlighting the Change History tab for an asset](/images/dagster-plus/deployment/code-locations/asset-change-history.png)

## Rolling back to a previous code location version

Expand All @@ -45,7 +45,7 @@ If you notice an issue with newly deployed code, or your code fails to deploy su
2. In the row associated with the code location you're interested in, click **View history** in the **Updated** column.
3. In the **Actions** column click the dropdown menu to the right of **View metadata**, select **Rollback to this version**.

![Screenshot highlighting the "Updated" column for a code location](/images/dagster-plus/code-locations/rollback-code-location.png)
![Screenshot highlighting the "Updated" column for a code location](/images/dagster-plus/deployment/code-locations/rollback-code-location.png)

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,11 @@ After the stack is installed, you'll be prompted to configure it. In the ECS wiz

The page should look similar to the following image. In this example, our organization name is `hooli` and our deployment is `prod`:

![Example Configuration for the ECS Agent CloudFormation Template](/images/dagster-cloud/agents/aws-ecs-stack-wizard-existing.png)
![Example Configuration for the ECS Agent CloudFormation Template](/images/dagster-plus/deployment/agents/aws-ecs-stack-wizard-existing.png)

After you've finished configuring the stack in AWS, you can view the agent in Dagster+. To do so, navigate to the **Status** page and click the **Agents** tab. You should see the agent running in the **Agent statuses** section:

![Instance Status](/images/dagster-cloud/agents/dagster-cloud-instance-status.png)
![Instance Status](/images/dagster-plus/deployment/agents/dagster-cloud-instance-status.png)

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ After the stack is installed, you'll be prompted to configure it. In the ECS wiz

The page should look similar to the following image. In this example, our organization name is `hooli` and our deployment is `prod`:

![Example Configuration for the ECS Agent CloudFormation Template](/images/dagster-cloud/agents/aws-ecs-stack-wizard-new.png)
![Example Configuration for the ECS Agent CloudFormation Template](/images/dagster-plus/deployment/agents/aws-ecs-stack-wizard-new.png)

After you've finished configuring the stack in AWS, you can view the agent in Dagster+. To do so, navigate to the **Status** page and click the **Agents** tab. You should see the agent running in the **Agent statuses** section:

![Instance Status](/images/dagster-cloud/agents/dagster-cloud-instance-status.png)
![Instance Status](/images/dagster-plus/deployment/agents/dagster-cloud-instance-status.png)

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A **hybrid deployment** utilizes a combination of your infrastructure and Dagste

The Dagster backend services - including the web frontend, GraphQL API, metadata database, and daemons (responsible for executing schedules and sensors) - are hosted in Dagster+. You are responsible for running an [agent](index.md#dagster-hybrid-agents) in your environment.

![Dagster+ Hybrid deployment architecture](/images/dagster-cloud/deployment/hybrid-architecture.png)
![Dagster+ Hybrid deployment architecture](/images/dagster-plus/deployment/hybrid-architecture.png)

Work is enqueued for your agent when:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This command:

To view the agent in Dagster+, click the Dagster icon in the top left to navigate to the **Status** page and click the **Agents** tab. You should see the agent running in the **Agent statuses** section:

![Instance Status](/images/dagster-cloud/agents/dagster-cloud-instance-status.png)
![Instance Status](/images/dagster-plus/deployment/agents/dagster-cloud-instance-status.png)

## Credential Helpers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ dagster-cloud agent run ~/dagster_home/

To view the agent in Dagster+, click the Dagster icon in the top left to navigate to the **Deployment > Agents** page. You should see the agent running in the **Agent statuses** section:

![Screenshot of Dagster Asset Lineage](/images/dagster-cloud/agents/dagster-cloud-instance-status.png)
![Screenshot of Dagster Asset Lineage](/images/dagster-plus/deployment/agents/dagster-cloud-instance-status.png)

## Next steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ In order from least to most isolated, there are three levels of isolation:

If you have no specific requirements for isolation beyond the ability to deploy and run multiple projects, you can use a single agent and deployment to manage all your projects as individual code locations.

![Diagram of isolation at the code location level](/images/dagster-cloud/managing-deployments/isolation-level-code-locations.png)
![Diagram of isolation at the code location level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-code-locations.png)

| **Pros** | **Cons** |
|----------|----------|
Expand All @@ -115,7 +115,7 @@ Motivations for utilizing this approach could include:
- Different compute requirements, such as different cloud providers or architectures
- Optimizing for locality or access, such as running the data processing closer or in environment with access to the storage locations

![Diagram of isolation at the agent level](/images/dagster-cloud/managing-deployments/isolation-level-agents.png)
![Diagram of isolation at the agent level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-agents.png)

| **Pros** | **Cons** |
|----------|----------|
Expand All @@ -129,7 +129,7 @@ Multiple deployments are only available in Dagster+ Pro.

Of the approaches outlined in this guide, multiple deployments are the most isolated solution. The typical motivation for this isolation level is to separate production and non-production environments.

![Diagram of isolation at the Dagster+ deployment level](/images/dagster-cloud/managing-deployments/isolation-level-deployments.png)
![Diagram of isolation at the Dagster+ deployment level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-deployments.png)

| **Pros** | **Cons** |
|----------|----------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ When prompted, you can specify a default deployment. If specified, a deployment
<details>
<summary><strong>TOKEN AUTHENTICATION</strong></summary>

Alternatively, you may authenticate using a user token. Refer to the [User tokens guide](/dagster-plus/deployment/management/tokens/user-tokens) for more info.
Alternatively, you may authenticate using a user token. Refer to the [User tokens guide](/dagster-plus/deployment/management/tokens) for more info.

```shell
$ dagster-cloud config setup
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ locations:

After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

!["Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)
!["Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+"](/images/dagster-plus/deployment/code-locations/redeploy-code-location.png)

</TabItem>
<TabItem value="Docker agents">
Expand All @@ -99,7 +99,7 @@ The `container_context.docker.env_vars` property is a list, where each item can

After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-plus/deployment/code-locations/redeploy-code-location.png)

</TabItem>
<TabItem value="Kubernetes agents">
Expand Down Expand Up @@ -130,7 +130,7 @@ locations:

After you've modified `dagster_cloud.yaml`, redeploy the code location in Dagster+ to apply the changes:

![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-cloud/developing-testing/code-locations/redeploy-code-location.png)
![Highlighted Redeploy option in the dropdown menu next to a code location in Dagster+](/images/dagster-plus/deployment/code-locations/redeploy-code-location.png)

</TabItem>
</Tabs>
Expand Down Expand Up @@ -164,7 +164,7 @@ To make environment variables accessible to a full deployment with an Amazon ECS

6. In the section displaying the template YAML, locate the `AgentTaskDefinition` section:

![Highlighted AgentTaskDefinition section of the AWS ECS agent CloudFormation template in the AWS Console](/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-cloudformation-template.png)
![Highlighted AgentTaskDefinition section of the AWS ECS agent CloudFormation template in the AWS Console](/images/dagster-plus/deployment/environment-variables/aws-ecs-cloudformation-template.png)


7. In the `user_code_launcher.config` portion of the `AgentTaskDefinition` section, add the environment variables as follows:
Expand All @@ -188,7 +188,7 @@ To make environment variables accessible to a full deployment with an Amazon ECS

8. When finished, click the **Create Stack** button:

![Highlighted Create Stack button in the AWS Console](/images/dagster-cloud/developing-testing/environment-variables/aws-ecs-save-template.png)
![Highlighted Create Stack button in the AWS Console](/images/dagster-plus/deployment/environment-variables/aws-ecs-save-template.png)

9. You'll be redirected back to the **Update stack** wizard, where the new template will be populated. Click **Next**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ To mask error messages in a Dagster+ Deployment, set the environment variable `D
alt="Environment variable UI showing DAGSTER_REDACT_USER_CODE_ERRORS set to 1"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/logs-error-messages/configure-redact-env-var.png',
dark: '/images/dagster-cloud/logs-error-messages/configure-redact-env-var.png',
light: '/images/dagster-plus/management/configure-redact-env-var.png',
dark: '/images/dagster-plus/management/configure-redact-env-var.png',
}}
/>

Expand All @@ -96,7 +96,7 @@ Once set, error messages from your code locations will be masked in the UI. A un
alt="Error message in Dagster event logs showing unique error ID"
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-cloud/logs-error-messages/masked-err-message.png',
dark: '/images/dagster-cloud/logs-error-messages/masked-err-message.png',
light: '/images/dagster-plus/management/masked-err-message.png',
dark: '/images/dagster-plus/management/masked-err-message.png',
}}
/>
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ In order from least to most isolated, there are three levels of isolation:

If you have no specific requirements for isolation beyond the ability to deploy and run multiple projects, you can use a single agent and deployment to manage all your projects as individual code locations.

![Diagram of isolation at the code location level](/images/dagster-cloud/managing-deployments/isolation-level-code-locations.png)
![Diagram of isolation at the code location level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-code-locations.png)

<table
className="table"
Expand Down Expand Up @@ -280,7 +280,7 @@ Motivations for utilizing this approach could include:
- Different compute requirements, such as different cloud providers or architectures
- Optimizing for locality or access, such as running the data processing closer or in environment with access to the storage locations

![Diagram of isolation at the agent level](/images/dagster-cloud/managing-deployments/isolation-level-agents.png)
![Diagram of isolation at the agent level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-agents.png)

<table
className="table"
Expand Down Expand Up @@ -334,7 +334,7 @@ Multiple deployments are only available in Dagster+ Pro.

Of the approaches outlined in this guide, multiple deployments are the most isolated solution. The typical motivation for this isolation level is to separate production and non-production environments. It may be considered to satisfy other organization specific requirements.

![Diagram of isolation at the Dagster+ deployment level](/images/dagster-cloud/managing-deployments/isolation-level-deployments.png)
![Diagram of isolation at the Dagster+ deployment level](/images/dagster-plus/deployment/management/managing-deployments/isolation-level-deployments.png)

<table
className="table"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ To manage tokens for another user, select the user from the **Manage tokens for*
<ThemedImage
style={{width:'100%', height: 'auto'}}
sources={{
light: '/images/dagster-plus/user-token-management/manage-user-tokens-for.png',
dark: '/images/dagster-plus/user-token-management/manage-user-tokens-for.png',
light: '/images/dagster-plus/deployment/management/user-token-management/manage-user-tokens-for.png',
dark: '/images/dagster-plus/deployment/management/user-token-management/manage-user-tokens-for.png',
}}
/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To view the Dagster+ Asset catalog, use the **Catalog** button on the top naviga

In any Dagster+ catalog page, you can access the current catalog view, or create a new catalog view with the catalog view dropdown at the top left of the screen. By default, this button is labeled **All assets**, and has a globe icon.

![Screenshot of the catalog view dropdown](/images/dagster-plus/asset-catalog/catalog-views.png)
![Screenshot of the catalog view dropdown](/images/dagster-plus/features/asset-catalog/catalog-views.png)

To create a new catalog view, you have two options:
- [Create a new catalog view from scratch](#creating-a-new-catalog-view-from-scratch), from the catalog view menu.
Expand All @@ -39,7 +39,7 @@ To create a new catalog view, you have two options:
4. To make the view shareable, toggle the **Public view** switch.
5. Click **Create view** to create the view.

![Screenshot of new catalog view modal](/images/dagster-plus/asset-catalog/new-catalog-view.png)
![Screenshot of new catalog view modal](/images/dagster-plus/features/asset-catalog/new-catalog-view.png)

Give your view a name and optionally a description and icon. Next, you can select one or more filters to apply to your view by clicking the **Add filters** button. Filters can select a subset of assets based on their [metadata]/guides/build/assets/metadata-and-tags/organizing-assets-with-tags-and-metadata), tags, kinds, owners, asset groups, or other properties.

Expand All @@ -53,7 +53,7 @@ When viewing the global asset lineage or asset list, you can create a new catalo
4. To make the view shareable, toggle the **Public view** switch.
5. Click **Create view** to create the view.

![Screenshot of creating catalog view from filters](/images/dagster-plus/asset-catalog/new-catalog-view-from-asset-page.png)
![Screenshot of creating catalog view from filters](/images/dagster-plus/features/asset-catalog/new-catalog-view-from-asset-page.png)

## Editing, duplicating, or deleting catalog views

Expand All @@ -62,4 +62,4 @@ When viewing the global asset lineage or asset list, you can create a new catalo
3. Click the **three dot menu** to the right of the view to display available options.
4. If modifying the view, note that any active filters will automatically be included in the set of changes. You can also change the view's name, description, icon, and sharing settings. 5. When finished, click **Save changes**.

![Screenshot of editing catalog views](/images/dagster-plus/asset-catalog/edit-catalog-view.png)
![Screenshot of editing catalog views](/images/dagster-plus/features/asset-catalog/edit-catalog-view.png)
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ The Dagster+ version of the asset catalog page displays assets broken out by com

To access the asset catalog, click **Catalog** in the top navigation.

![The Asset Catalog page in the Dagster UI](/images/dagster-plus/asset-catalog/asset-catalog-cloud-pro.png)
![The Asset Catalog page in the Dagster UI](/images/dagster-plus/features/asset-catalog/asset-catalog-cloud-pro.png)
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ By default, users will be granted Viewer permissions on each deployment. The def

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).

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

## Adding users to teams \{#teams}

Expand All @@ -47,7 +47,7 @@ Teams are a Dagster+ Pro feature.

Teams are useful for centralizing permission sets for different types of users. Refer to [Managing teams](teams) for more information about creating and managing teams.

![Screenshot of Managing teams page](/images/dagster-plus/authentication-and-access-control/mananging-teams.png)
![Screenshot of Managing teams page](/images/dagster-plus/features/authentication-and-access-control/mananging-teams.png)

:::note
When determining a user's level of access, Dagster+ will use the **most permissive** role assigned to the user between all of their team memberships and any individual role grants. Refer to [Managing user roles and permissions](user-roles-permissions) for more information.
Expand Down
Loading

2 comments on commit 0d727d6

@github-actions
Copy link

Choose a reason for hiding this comment

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

Deploy preview for dagster-docs-legacy ready!

✅ Preview
https://dagster-docs-legacy-ibxy93nw7-elementl.vercel.app
https://master.dagster.dagster-docs.io

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

@github-actions
Copy link

@github-actions github-actions bot commented on 0d727d6 Jan 22, 2025

Choose a reason for hiding this comment

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

Deploy preview for dagster-docs-beta ready!

✅ Preview
https://dagster-docs-beta-amdylmgqa-elementl.vercel.app

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

Please sign in to comment.