From 6a409551d4ffea2ab16b9c99121c8856562a97c3 Mon Sep 17 00:00:00 2001 From: Pedram Navid <1045990+PedramNavid@users.noreply.github.com> Date: Sun, 25 Aug 2024 18:44:23 -0700 Subject: [PATCH] Resolve vale errors --- .../guides/data-modeling/external-assets.md | 18 +++++++++--------- docs/vale/styles/Dagster/headings-gerund.yml | 10 ---------- docs/vale/styles/Terms/dagster.yml | 4 +++- .../config/vocabularies/Dagster/accept.txt | 7 ++++++- 4 files changed, 18 insertions(+), 21 deletions(-) delete mode 100644 docs/vale/styles/Dagster/headings-gerund.yml diff --git a/docs/docs-beta/docs/guides/data-modeling/external-assets.md b/docs/docs-beta/docs/guides/data-modeling/external-assets.md index 93d08200d8723..abb32b911ada6 100644 --- a/docs/docs-beta/docs/guides/data-modeling/external-assets.md +++ b/docs/docs-beta/docs/guides/data-modeling/external-assets.md @@ -4,13 +4,13 @@ sidebar_position: 80 sidebar_label: 'Representing external data sources' --- -One of Dagster's goals is to present a single unified lineage of all of the data assets in an organization. This can include assets orchestrated by Dagster as well as assets orchestrated by other systems. +One of Dagster's goals is to present a single unified lineage of all of the data assets in an organization. This can include assets orchestrated by Dagster and assets orchestrated by other systems. -**External assets** enable you to model assets orchestrated by other systems natively within Dagster's asset catalog, and create new data assets downstream of these external assets. +**External assets** enable you to model assets orchestrated by other systems natively within Dagster's Asset catalog, and create new data assets downstream of these external assets. -External assets differ from native Dagster assets in that Dagster cannot materialize them directly or put them on a schedule. Instead, an external system must inform Dagster of when an external asset is updated. +External assets differ from native Dagster assets in that Dagster can't materialize them directly or put them on a schedule. Instead, an external system must inform Dagster of when an external asset is updated. -Examples of external assets could be files in a data lake that are populated by a bespoke internal tool, a CSV file delivered daily via SFTP from a partner, or a table in a data warehouse populated by another orchestrator. +Examples of external assets could be files in a data lake that are populated by a bespoke internal tool, a CSV file delivered daily by SFTP from a partner, or a table in a data warehouse populated by another orchestrator. ## What you'll learn @@ -34,7 +34,7 @@ To follow the steps in this guide, you'll need: ## Creating and depending on external assets -Let's imagine that we have a partner that sends us some raw transaction data via SFTP on, roughly, a daily basis, that is later cleaned and stored in an internal data lake. Because the raw transaction data is not materialized by Dagster, it makes sense to model it as an external asset. +Let's imagine that we have a partner that sends us some raw transaction data by SFTP on, roughly, a daily basis, that's later cleaned and stored in an internal data lake. Because the raw transaction data isn't materialized by Dagster, it makes sense to model it as an external asset. @@ -42,9 +42,9 @@ See the [AssetSpec API docs](/todo) for all the potential parameters you can pro ## Recording materializations and metadata -In the above example, we simply modeled the external asset in the asset graph. We also need to inform Dagster whenever an external asset is updated, and include any relevant metadata about the asset. +In the preceding example, we modeled the external asset in the asset graph. We also need to inform Dagster whenever an external asset is updated, and include any relevant metadata about the asset. -There are two main ways to do this: "pulling" external assets events with sensors, and "pushing" external asset events via the REST API. +There are two main ways to do this: "pulling" external assets events with sensors, and "pushing" external asset events using the REST API. ### "Pulling" with sensors @@ -58,7 +58,7 @@ See the [sensors guide](/guides/automation/sensors) for more information about s ### "Pushing" with the REST API -You can inform Dagster that an external asset has materialized by "pushing" the event from an external system via the REST API. +You can inform Dagster that an external asset has materialized by "pushing" the event from an external system to the REST API. For example, here's how we would inform Dagster of a materialization of the `raw_transactions` external asset in Dagster+: @@ -77,7 +77,7 @@ curl \ }' ``` -If you're using open-source, you don't need the authentication headers and should point it at your open-source URL (in this example, `http://localhost:3000`): +If you're using open source, you don't need the authentication headers and should point it at your open source URL (in this example, `http://localhost:3000`): ```shell curl \ diff --git a/docs/vale/styles/Dagster/headings-gerund.yml b/docs/vale/styles/Dagster/headings-gerund.yml deleted file mode 100644 index dcbed29ed590e..0000000000000 --- a/docs/vale/styles/Dagster/headings-gerund.yml +++ /dev/null @@ -1,10 +0,0 @@ -## This rule flags gerunds (ex: "Linting" versus "Lint") in section headings -## WHY? Gerunds don't always translate well into other languages - -extends: existence -message: Section '%v' should not start with a gerund (verb ending in "ing") -level: error -scope: heading -ignorecase: false -raw: - ^(?!Troubleshooting)(\w+ing\b.*)$ diff --git a/docs/vale/styles/Terms/dagster.yml b/docs/vale/styles/Terms/dagster.yml index 0d0c280173370..f26efa9304191 100644 --- a/docs/vale/styles/Terms/dagster.yml +++ b/docs/vale/styles/Terms/dagster.yml @@ -11,4 +11,6 @@ swap: dagster plus: Dagster+ '[Dd]agit': "Dagster UI" '[Ss]oftware-defined [Aa]sset': &asset-def asset definition|asset - '[Ss][Dd][Aa]': *asset-def \ No newline at end of file + '[Ss][Dd][Aa]': *asset-def + '[Rr][Ee][Ss][Tt]\s*[Aa][Pp][Ii]': REST API + diff --git a/docs/vale/styles/config/vocabularies/Dagster/accept.txt b/docs/vale/styles/config/vocabularies/Dagster/accept.txt index da73bea609b81..9cc16fd8b9279 100644 --- a/docs/vale/styles/config/vocabularies/Dagster/accept.txt +++ b/docs/vale/styles/config/vocabularies/Dagster/accept.txt @@ -1,11 +1,13 @@ [Cc]onfig \bDagster\b +DAG DataFrame Declarative Automation dagster-.* gRPC [Mm]aterializations [Mm]emoization +REST API [Ss]ubprocess Serverless @@ -31,4 +33,7 @@ PingOne Postgres S3 Snowflake -Twilio \ No newline at end of file +Twilio + +We have +we have