Skip to content

Commit

Permalink
Fix broken link and other vale warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
@petehunt
petehunt committed Aug 26, 2024
1 parent 9be2735 commit efca868
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/docs-beta/docs/guides/data-modeling/metadata.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Here's an example of some tags you might apply to an asset:
{"domain": "marketing", "pii": "true"}
```

**Metadata** allows you to attach rich information to the asset, like a Markdown description, a table schema, or a time series. Metadata is more flexible than tags, as it can store more complex information. Metadata can be attached to an asset at definition time (i.e. when the code is first imported) or at runtime (every time an asset is materialized).
**Metadata** allows you to attach rich information to the asset, like a Markdown description, a table schema, or a time series. Metadata is more flexible than tags, as it can store more complex information. Metadata can be attached to an asset at definition time (that is, when the code is first imported) or at runtime (every time an asset is materialized).

Check warning on line 57 in docs/docs-beta/docs/guides/data-modeling/metadata.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.contractions] Use 'that's' instead of 'that is'.

Raw Output:
{"message": "[Dagster.contractions] Use 'that's' instead of 'that is'.", "location": {"path": "docs/docs-beta/docs/guides/data-modeling/metadata.md", "range": {"start": {"line": 57, "column": 265}}}, "severity": "INFO"}

Here's an example of some metadata you might apply to an asset:

Expand Down Expand Up @@ -96,19 +96,19 @@ Any numerical metadata will be treated as a time series in the Dagster UI.

Some metadata keys will be given special treatment in the Dagster UI.

| Key | Description |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dagster/uri` | **Type:** `str` <br/><br/> The URI for the asset, e.g. "s3://my_bucket/my_object" |
| `dagster/column_schema` | **Type:** [`TableSchema`](/todo) <br/><br/> For an asset that's a table, the schema of the columns in the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. |
| `dagster/column_lineage` | **Type:** [`TableColumnLineage`](/todo) <br/><br/> For an asset that's a table, the lineage of column inputs to column outputs for the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. |
| `dagster/row_count` | **Type:** `int` <br/><br/> For an asset that's a table, the number of rows in the table. Refer to the Table metadata documentation for details. |
| `dagster/partition_row_count` | **Type:** `int` <br/><br/> For a partition of an asset that's a table, the number of rows in the partition. |
| `dagster/relation_identifier` | **Type:** `str` <br/><br/> A unique identifier for the table/view, typically fully qualified. For example, my_database.my_schema.my_table |
| `dagster/code_references` | **Type:** [`CodeReferencesMetadataValue`](/todo) <br/><br/> A list of code references for the asset, such as file locations or references to GitHub URLs. Refer to the [Linking assets with their source code](#linking-your-assets-with-their-source-code) section for details. Should only be provided in definition-level metadata, not materialization metadata. |
| Key | Description |
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `dagster/uri` | **Type:** `str` <br/><br/> The URI for the asset, e.g. "s3://my_bucket/my_object" |

Check warning on line 101 in docs/docs-beta/docs/guides/data-modeling/metadata.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.latin] Use 'for example' instead of 'e.g.', but consider rewriting the sentence.

Raw Output:
{"message": "[Dagster.latin] Use 'for example' instead of 'e.g.', but consider rewriting the sentence.", "location": {"path": "docs/docs-beta/docs/guides/data-modeling/metadata.md", "range": {"start": {"line": 101, "column": 85}}}, "severity": "WARNING"}

Check failure on line 101 in docs/docs-beta/docs/guides/data-modeling/metadata.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'S3' instead of 's3'.

Raw Output:
{"message": "[Vale.Terms] Use 'S3' instead of 's3'.", "location": {"path": "docs/docs-beta/docs/guides/data-modeling/metadata.md", "range": {"start": {"line": 101, "column": 91}}}, "severity": "ERROR"}
| `dagster/column_schema` | **Type:** [`TableSchema`](/todo) <br/><br/> For an asset that's a table, the schema of the columns in the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. |
| `dagster/column_lineage` | **Type:** [`TableColumnLineage`](/todo) <br/><br/> For an asset that's a table, the lineage of column inputs to column outputs for the table. Refer to the [Table and column metadata](#table-and-column-metadata) section for details. |
| `dagster/row_count` | **Type:** `int` <br/><br/> For an asset that's a table, the number of rows in the table. Refer to the Table metadata documentation for details. |
| `dagster/partition_row_count` | **Type:** `int` <br/><br/> For a partition of an asset that's a table, the number of rows in the partition. |
| `dagster/relation_identifier` | **Type:** `str` <br/><br/> A unique identifier for the table/view, typically fully qualified. For example, my_database.my_schema.my_table |
| `dagster/code_references` | **Type:** [`CodeReferencesMetadataValue`](/todo) <br/><br/> A list of code references for the asset, such as file locations or references to GitHub URLs. Refer to the [Linking assets with their source code](#linking-assets-with-their-source-code) section for details. Should only be provided in definition-level metadata, not materialization metadata. |

## Table and column metadata

Two of the most powerful metadata types are [`TableSchema`](/todo) and [`TableColumnLineage`](/todo). These metadata types allow stakeholders to view the schema of a table right within Dagster, and, in Dagster+, navigate the [asset catalog](/todo) via the column lineage.
Two of the most powerful metadata types are [`TableSchema`](/todo) and [`TableColumnLineage`](/todo). These metadata types allow stakeholders to view the schema of a table right within Dagster, and, in Dagster+, navigate the [Asset catalog](/todo) via the column lineage.

Check warning on line 111 in docs/docs-beta/docs/guides/data-modeling/metadata.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Dagster.latin] Use 'with', 'through', or 'by using' instead of 'via', but consider rewriting the sentence.

Raw Output:
{"message": "[Dagster.latin] Use 'with', 'through', or 'by using' instead of 'via', but consider rewriting the sentence.", "location": {"path": "docs/docs-beta/docs/guides/data-modeling/metadata.md", "range": {"start": {"line": 111, "column": 249}}}, "severity": "WARNING"}

### Table schema metadata

Expand All @@ -132,7 +132,7 @@ Column lineage metadata is a powerful way to track how columns in a table are de

:::tip

Dagster+ provides rich visualization and navigation of column lineage in the asset catalog. Refer to the [Dagster+ documentation](/dagster-plus) for more information.
Dagster+ provides rich visualization and navigation of column lineage in the Asset catalog. Refer to the [Dagster+ documentation](/dagster-plus) for more information.

:::

Expand Down

0 comments on commit efca868

Please sign in to comment.