Skip to content

Commit

Permalink
docs(custom-plugins): add overview image (datahub-project#11634)
Browse files Browse the repository at this point in the history
  • Loading branch information
david-leifker authored Oct 16, 2024
1 parent ce909c8 commit 4be6645
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions metadata-models-custom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,19 @@ that were loaded for debugging purposes.
}
```

#### Custom Plugin Ecosystem Overview

The following diagram shows the overall picture of the various validators, mutators, and side effects shown within
the context of typical read/write operations within DataHub. Each component is discussed in further detail in the
sections below.

<p align="center">
<img width="80%" src="https://raw.githubusercontent.com/datahub-project/static-assets/main/imgs/metadata-models-custom/custom-plugin-overview.svg"/>
</p>

In the diagram above, the circles represent Aspects (custom aspects or standard). As the Aspects progress they can be mutated/changed,
rejected, or additional aspects can be generated by side effects.

#### Custom Validators

Custom aspects might require that instances of those aspects adhere to specific conditions or rules. These conditions could vary wildly depending on the use case however they could be as simple
Expand Down

0 comments on commit 4be6645

Please sign in to comment.