Skip to content

Commit

Permalink
Merge pull request #18 from dagster-io/nikki/fix-docs-links
Browse files Browse the repository at this point in the history
DOC-743 Update docs links
  • Loading branch information
cmpadden authored Jan 24, 2025
2 parents 8353483 + 49dbc38 commit a94577d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ What you need to start using this template:

1. A [Dagster Cloud](https://dagster.cloud/) account set up for Hybrid deployments.

2. A [Hybrid agent](https://docs.dagster.io/dagster-cloud/deployment/agents) up and running.
2. A [Hybrid agent](https://docs.dagster.io/dagster-plus/deployment/deployment-types/hybrid/) up and running.

3. A Docker container registry accessible from the hybrid agent and from your GitHub workflows.

Expand Down Expand Up @@ -52,7 +52,7 @@ Set up secrets on your newly created repository by navigating to the `Settings`

| Name | Description |
|----------------|-------------|
| `DAGSTER_CLOUD_API_TOKEN` | An agent token, for more details see [the Dagster Cloud docs](https://docs.dagster.io/dagster-cloud/account/managing-user-agent-tokens). |
| `DAGSTER_CLOUD_API_TOKEN` | An agent token, for more details see [the Dagster Cloud docs](https://docs.dagster.io/deployment/management/tokens/agent-tokens). |
| Docker access secrets | Depending on which Docker registry you are using, you must define the credentials listed in the workflow file. |

Here is an example screenshot showing the secrets for AWS ECR.
Expand All @@ -71,15 +71,15 @@ At this point, the workflow run should complete successfully and you should see

Once you have the `quickstart_etl` example deployed, you can replace the sample code with your Dagster project. You will then need to update the `dagster_cloud.yaml` file:

1. Update `dagster_cloud.yaml`. See [documentation](https://docs.dagster.io/dagster-cloud/managing-deployments/dagster-cloud-yaml#dagster_cloudyaml) for details.
1. Update `dagster_cloud.yaml`. See [documentation](https://docs.dagster.io/dagster-plus/deployment/code-locations/dagster-cloud-yaml) for details.

2. If you have more than one code location, duplicate the `build-docker-image` and the `"ci set-build-output"` steps in `dagster-cloud-deploy.yaml` for the new code locations.

# Advanced customization

## Disable branch deployments

[Branch Deployments](https://docs.dagster.io/dagster-cloud/developing-testing/branch-deployments) are enabled by default. To disable them comment out the for your Hybrid agent, comment out the `pull_request` section in `dagster_cloud.yaml`:
[Branch Deployments](https://docs.dagster.io/dagster-plus/features/ci-cd/branch-deployments/) are enabled by default. To disable them comment out the for your Hybrid agent, comment out the `pull_request` section in `dagster_cloud.yaml`:

https://github.com/dagster-io/dagster-cloud-hybrid-quickstart/blob/9f63f62b1a7ca0ed133f91ceb5f378ee67b3096a/.github/workflows/dagster-cloud-deploy.yml#L7-L8

Expand Down
4 changes: 2 additions & 2 deletions quickstart_etl/assets/hackernews.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def hackernews_topstories(
# Dagster supports attaching arbitrary metadata to asset materializations. This metadata will be
# shown in the run logs and also be displayed on the "Activity" tab of the "Asset Details" page in the UI.
# This metadata would be useful for monitoring and maintaining the asset as you iterate.
# Read more about in asset metadata in https://docs.dagster.io/concepts/assets/software-defined-assets#recording-materialization-metadata
# Read more about in asset metadata in https://docs.dagster.io/guides/build/assets/metadata-and-tags/#runtime-metadata
context.add_output_metadata(
{
"num_records": len(df),
Expand Down Expand Up @@ -77,7 +77,7 @@ def hackernews_topstories_word_cloud(
md_content = f"![img](data:image/png;base64,{image_data.decode()})"

# Attach the Markdown content as metadata to the asset
# Read about more metadata types in https://docs.dagster.io/_apidocs/ops#metadata-types
# Read about more metadata types in https://docs.dagster.io/api/python-api/metadata#metadata-types
context.add_output_metadata({"plot": MetadataValue.md(md_content)})

return image_data

0 comments on commit a94577d

Please sign in to comment.