@eventcatalog/core 4.1.3 → 4.1.4

package/dist/docs/development/guides/resources/data/04-reference.md

@@ -0,0 +1,211 @@
+---
+keywords:
+- EventCatalog data stores
+- Data store frontmatter
+sidebar_label: Reference
+title: Data stores reference
+description: Frontmatter fields, paths, and routes for data stores in EventCatalog.
+---
+
+This page lists the fields, paths, and routes supported by data stores.
+
+## Paths
+
+Data stores use the `containers` collection.
+
+```txt
+/containers/{Data Store Name}/index.mdx
+/services/{Service Name}/containers/{Data Store Name}/index.mdx
+/systems/{System Name}/containers/{Data Store Name}/index.mdx
+```
+
+Versioned data stores use:
+
+```txt
+/containers/{Data Store Name}/versioned/{version}/index.mdx
+```
+
+## Routes
+
+| Route | Description |
+|-------|-------------|
+| `/docs/containers/{container-id}/{version}` | Data store documentation page. |
+| `/visualiser/containers/{container-id}/{version}` | Data store resource diagram. |
+
+## Required fields
+
+### `id` {#id}
+
+- Type: `string`
+
+Unique id of the data store. EventCatalog uses this for URLs and resource references.
+
+```md title="Example"
+---
+id: orders-database
+---
+```
+
+### `name` {#name}
+
+- Type: `string`
+
+Display name of the data store.
+
+```md title="Example"
+---
+name: Orders Database
+---
+```
+
+### `version` {#version}
+
+- Type: `string`
+
+Version of the data store documentation.
+
+```md title="Example"
+---
+version: 1.0.0
+---
+```
+
+## Optional fields
+
+### `summary` {#summary}
+
+- Type: `string`
+
+Short description of the data store.
+
+```md title="Example"
+---
+summary: Stores order state and fulfilment status.
+---
+```
+
+### `container_type` {#container_type}
+
+- Type: `database`, `cache`, `objectStore`, `searchIndex`, `dataWarehouse`, `dataLake`, `externalSaaS`, or `other`
+
+Type of data store.
+
+```md title="Example"
+---
+container_type: database
+---
+```
+
+### `technology` {#technology}
+
+- Type: `string`
+
+Technology used by the data store.
+
+```md title="Example"
+---
+technology: PostgreSQL
+---
+```
+
+### `authoritative` {#authoritative}
+
+- Type: `boolean`
+
+Marks this data store as an authoritative source of data.
+
+```md title="Example"
+---
+authoritative: true
+---
+```
+
+### `access_mode` {#access_mode}
+
+- Type: `read`, `write`, `readWrite`, or `appendOnly`
+
+How consumers interact with the data store.
+
+```md title="Example"
+---
+access_mode: readWrite
+---
+```
+
+### `classification` {#classification}
+
+- Type: `public`, `internal`, `confidential`, or `regulated`
+
+Data classification.
+
+```md title="Example"
+---
+classification: confidential
+---
+```
+
+### `residency` {#residency}
+
+- Type: `string`
+
+Region or residency information.
+
+```md title="Example"
+---
+residency: eu-west-1
+---
+```
+
+### `retention` {#retention}
+
+- Type: `string`
+
+Retention policy or duration.
+
+```md title="Example"
+---
+retention: 7 years
+---
+```
+
+### `owners` {#owners}
+
+- Type: `array`
+
+An array of team or user ids that own the data store.
+
+```md title="Example"
+---
+owners:
+  - data-platform
+---
+```
+
+### `services` {#services}
+
+- Type: `array`
+
+Services associated with the data store.
+
+```md title="Example"
+---
+services:
+  - id: order-service
+    version: 1.0.0
+---
+```
+
+### `badges` {#badges}
+
+- Type: `array`
+
+Badges rendered on the data store page.
+
+```md title="Example"
+---
+badges:
+  - content: Authoritative
+    backgroundColor: green
+    textColor: green
+---
+```

package/dist/docs/development/guides/{data → resources/data}/_category_.json

@@ -1,11 +1,11 @@
 {
   "label": "Data Stores",
-  "position": 11,
+  "position": 4,
   "collapsible": true,
   "collapsed": true,
   "link": {
     "type": "generated-index",
-    "slug": "/data",
+    "slug": "/resources/data",
     "description": "A collection of guides to help you understand data resources and how they work with EventCatalog."
   }
-}
+}

package/dist/docs/development/guides/{data-products → resources/data-products}/01-introduction.md

@@ -10,25 +10,9 @@ description: Data as a product for analytics and insights
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
 
-<AddedIn version="3.8.0" />
-
-:::warning Beta Feature
-
-Data Products are currently in **beta** and accepting feedback. The feature and API may change based on community input. Please share your feedback and use cases to help shape the final design.
-
-:::
-
 Data products in EventCatalog represent analytical datasets that transform raw operational (e.g databases, messages, channels) data into high-quality, discoverable, and reusable information assets.
 
-A data product may consumes inputs (e.g [events](/docs/development/guides/messages/events/introduction), [services](/docs/development/guides/services/introduction), [data stores](/docs/development/guides/data/introduction)) and produces outputs (e.g [data stores](/docs/development/guides/data/introduction), metrics) optimized for specific use cases like reporting, business intelligence, or machine learning.
-
-:::tip Data products are first-class resources
-
-Data products have full support in EventCatalog including visualization, schema contracts, versioning, ownership, and relationships with other resources.
-
-You can read more about data products from thoughtworks [here](https://www.thoughtworks.com/en-us/insights/decoder/d/data-product).
-
-:::
+A data product may consumes inputs (e.g [events](/docs/development/guides/resources/messages/message-types/events), [services](/docs/development/guides/resources/services/introduction), [data stores](/docs/development/guides/resources/data/introduction)) and produces outputs (e.g [data stores](/docs/development/guides/resources/data/introduction), metrics) optimized for specific use cases like reporting, business intelligence, or machine learning.
 
 ## Key characteristics
 

package/dist/docs/development/guides/resources/data-products/02-adding-data-products.md

@@ -0,0 +1,174 @@
+---
+sidebar_position: 2
+keywords:
+- EventCatalog data products
+sidebar_label: Create a data product
+title: Create a data product
+description: Creating and managing data products
+---
+
+import AddedIn from '@site/src/components/MDX/AddedIn';
+import PromptBox from '@site/src/components/MDX/PromptBox';
+import ProjectTree from '@site/src/components/MDX/ProjectTree';
+
+<AddedIn version="3.8.0" />
+
+Data products document analytical datasets that transform operational (e.g databases, messages, channels) data into insights. Adding a data product helps teams understand data lineage, contracts, and consumption patterns.
+
+![Example](./img/data-product.png)
+
+## Adding a new data product
+
+### Automatic Creation
+
+<PromptBox preview="Create a new EventCatalog data product">
+Read https://www.eventcatalog.dev/docs/development/guides/resources/data-products/adding-data-products.md and https://raw.githubusercontent.com/event-catalog/skills/refs/heads/main/skills/catalog-documentation-creator/references/data-products.md then help me create a new EventCatalog data product in my catalog.
+
+Ask me for the data product name, what analytical dataset it provides, summary, owners, whether it belongs at the root of the catalog or inside a domain, and any known inputs, outputs, or data contracts. Then create the correct data-products/{'{Data Product Name}'}/index.mdx or domains/{'{Domain Name}'}/data-products/{'{Data Product Name}'}/index.mdx file with frontmatter and starter markdown, you can add as much markdown as you want that captures the users input.
+
+If the data product has output contracts, ask me for the contract file names, types, and where those contract files should live.
+
+If the catalog does not have any domains, put it into the root data-products folder.
+
+You can use MDX components found here https://raw.githubusercontent.com/event-catalog/skills/refs/heads/main/skills/catalog-documentation-creator/references/components.md
+</PromptBox>
+
+Copy this prompt and paste it into your coding agent. Your agent can help you choose where the data product should live, create the right folder structure, and add the first version of the data product documentation.
+
+### Manual Creation
+
+Data products live in a `data-products` folder. EventCatalog discovers any `index.mdx` file inside a `data-products` directory, regardless of where that directory lives in your catalog.
+
+You can place data products:
+
+At the root of your catalog:
+
+<ProjectTree
+  items={[
+    {
+      name: 'data-products',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'OrderAnalytics',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx', highlight: true },
+            { name: 'fact-orders-contract.json' },
+          ],
+        },
+        {
+          name: 'PaymentMetrics',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            { name: 'index.mdx', highlight: true },
+            { name: 'payment-contract.json' },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+Inside a domain:
+
+<ProjectTree
+  items={[
+    {
+      name: 'domains',
+      type: 'folder',
+      defaultOpen: true,
+      children: [
+        {
+          name: 'E-Commerce',
+          type: 'folder',
+          defaultOpen: true,
+          children: [
+            {
+              name: 'data-products',
+              type: 'folder',
+              defaultOpen: true,
+              children: [
+                {
+                  name: 'CustomerSegmentation',
+                  type: 'folder',
+                  defaultOpen: true,
+                  children: [{ name: 'index.mdx', highlight: true }],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
+
+The contents are split into two sections: **frontmatter** and **markdown content**.
+
+## Create the data product file
+
+Create an `index.mdx` file for the data product.
+
+Here is an example data product markdown file. [You can read the data product reference](/docs/development/guides/resources/data-products/reference).
+
+```md title="/data-products/OrderAnalytics/index.mdx (example)"
+---
+# Unique identifier for your data product
+id: order-analytics
+
+# Display name rendered in EventCatalog
+name: Order Analytics
+
+# Version of the data product
+version: 1.0.0
+
+# Brief summary of what this data product provides
+summary: Aggregated order metrics and KPIs for business intelligence
+
+# Optional owners (references teams or users)
+owners:
+  - dboyne
+
+# Optional badges for categorization
+badges:
+  - content: Analytics
+    backgroundColor: purple
+    textColor: purple
+  - content: dbt
+    backgroundColor: orange
+    textColor: orange
+
+# Input dependencies (events, services, data stores)
+inputs:
+  - id: OrderConfirmed
+    # version is optional for all inputs
+    version: 1.0.0
+  - id: PaymentProcessed
+  - id: payment-cache
+
+# Output data products (events, services, data stores)
+outputs:
+  - id: OrderMetricsCalculated
+    # version is optional for all outputs
+    version: 1.0.0
+  - id: NotificationService
+  - id: orders-db
+    contract:
+      path: fact-orders-contract.json
+      name: Fact Orders Contract
+      type: json-schema
+---
+
+## Overview
+
+The Order Analytics data product transforms raw order and payment events into aggregated metrics optimized for reporting and business intelligence.
+
+<NodeGraph />
+
+Rest of your markdown....
+```
+

package/dist/docs/development/guides/{data-products → resources/data-products}/03-inputs-and-outputs.md

@@ -9,13 +9,11 @@ description: Define dependencies and consumers
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
 
-<AddedIn version="3.8.0" />
-
 Data products consume inputs (e.g events, services, data stores, channels) and produce outputs (e.g events, services, data stores, channels). Defining these relationships helps teams understand data lineage and dependencies.
 
 ## Defining inputs (input ports)
 
-Inputs represent the source dependencies your data product consumes. In EventCatalog these can be [events](/docs/development/guides/messages/events/introduction), commands, queries, [services](/docs/development/guides/services/introduction), [data stores](/docs/development/guides/data/introduction), or [channels](/docs/development/guides/channels/introduction).
+Inputs represent the source dependencies your data product consumes. In EventCatalog these can be [events](/docs/development/guides/resources/messages/message-types/events), commands, queries, [services](/docs/development/guides/resources/services/introduction), [data stores](/docs/development/guides/resources/data/introduction), or [channels](/docs/development/guides/resources/messages/message-channels/introduction).
 
 You need to specify the `id` of the input and optionally the `version` of the input. If no version is provided the latest version will be used.
 
@@ -123,6 +121,6 @@ Transaction-level payment data with fraud scores.
 
 ## Next steps
 
-- [Add schema contracts](/docs/development/guides/data-products/contracts)
-- [Version data products](/docs/development/guides/data-products/versioning)
-- [Add to domains](/docs/development/guides/data-products/adding-to-domains)
+- [Add schema contracts](/docs/development/guides/resources/data-products/contracts)
+- [Version data products](/docs/development/guides/versioning-resources)
+- [Add to domains](/docs/development/guides/domains/add-resources-to-domains/add-data-products-to-domains)

package/dist/docs/development/guides/{data-products → resources/data-products}/04-contracts.md

@@ -9,8 +9,6 @@ description: Define schema contracts for outputs
 
 import AddedIn from '@site/src/components/MDX/AddedIn';
 
-<AddedIn version="3.8.0" />
-
 Contracts define the schema structure for data product outputs. They provide clear expectations for downstream consumers and enable schema validation.
 
 Your contracts can be any format you want (e.g JSON Schema, ODCS YAML, etc).
@@ -97,6 +95,6 @@ outputs:
 
 ## Next steps
 
-- [Version data products](/docs/development/guides/data-products/versioning)
-- [Add to domains](/docs/development/guides/data-products/adding-to-domains)
+- [Version data products](/docs/development/guides/versioning-resources)
+- [Add to domains](/docs/development/guides/domains/add-resources-to-domains/add-data-products-to-domains)
 - [Schema explorer component](/docs/development/components/using-components)

package/dist/docs/development/guides/resources/data-products/07-reference.md

@@ -0,0 +1,201 @@
+---
+keywords:
+- EventCatalog data products
+- Data product frontmatter
+sidebar_label: Reference
+title: Data products reference
+description: Frontmatter fields, paths, and routes for data products in EventCatalog.
+---
+
+This page lists the fields, paths, and routes supported by data products.
+
+## Paths
+
+Data products can be created in any `data-products` folder:
+
+```txt
+/data-products/{Data Product Name}/index.mdx
+/domains/{Domain Name}/data-products/{Data Product Name}/index.mdx
+```
+
+Versioned data products use:
+
+```txt
+/data-products/{Data Product Name}/versioned/{version}/index.mdx
+```
+
+## Routes
+
+| Route | Description |
+|-------|-------------|
+| `/docs/data-products/{data-product-id}/{version}` | Data product documentation page. |
+| `/visualiser/data-products/{data-product-id}/{version}` | Data product resource diagram. |
+
+## Required fields
+
+### `id` {#id}
+
+- Type: `string`
+
+Unique id of the data product. EventCatalog uses this for URLs and resource references.
+
+```md title="Example"
+---
+id: customer-analytics
+---
+```
+
+### `name` {#name}
+
+- Type: `string`
+
+Display name of the data product.
+
+```md title="Example"
+---
+name: Customer Analytics
+---
+```
+
+### `version` {#version}
+
+- Type: `string`
+
+Version of the data product documentation.
+
+```md title="Example"
+---
+version: 1.0.0
+---
+```
+
+## Optional fields
+
+### `summary` {#summary}
+
+- Type: `string`
+
+Short description of the data product.
+
+```md title="Example"
+---
+summary: Curated customer analytics dataset for reporting and segmentation.
+---
+```
+
+### `owners` {#owners}
+
+- Type: `array`
+
+An array of team or user ids that own the data product.
+
+```md title="Example"
+---
+owners:
+  - data-platform
+---
+```
+
+### `inputs` {#inputs}
+
+- Type: `array`
+
+Resources used as inputs to the data product.
+
+```md title="Example"
+---
+inputs:
+  - id: customer-database
+    type: container
+---
+```
+
+### `outputs` {#outputs}
+
+- Type: `array`
+
+Outputs produced by the data product.
+
+```md title="Example"
+---
+outputs:
+  - id: customer-analytics
+    contract:
+      path: contracts/customer-analytics.avro
+      name: Customer analytics contract
+      type: avro
+---
+```
+
+### `badges` {#badges}
+
+- Type: `array`
+
+Badges rendered on the data product page.
+
+```md title="Example"
+---
+badges:
+  - content: Certified
+    backgroundColor: green
+    textColor: green
+---
+```
+
+### `repository` {#repository}
+
+- Type: `object`
+
+Repository metadata for the data product.
+
+```md title="Example"
+---
+repository:
+  language: SQL
+  url: https://github.com/acme/customer-analytics
+---
+```
+
+### `diagrams` {#diagrams}
+
+- Type: `array`
+
+Diagrams associated with the data product.
+
+```md title="Example"
+---
+diagrams:
+  - id: customer-analytics-lineage
+    version: 1.0.0
+---
+```
+
+### `attachments` {#attachments}
+
+- Type: `array`
+
+External links or supporting documents attached to the data product.
+
+```md title="Example"
+---
+attachments:
+  - title: Data contract review
+    url: https://docs.example.com/customer-analytics
+    type: document
+---
+```
+
+## Output contracts
+
+Outputs can include a contract that describes the data product output.
+
+```md
+---
+outputs:
+  - id: customer-analytics
+    contract:
+      path: contracts/customer-analytics.avro
+      name: Customer analytics contract
+      type: avro
+---
+```

package/dist/docs/development/guides/{data-products → resources/data-products}/_category_.json

@@ -1,11 +1,11 @@
 {
   "label": "Data Products",
-  "position": 11,
+  "position": 5,
   "collapsible": true,
   "collapsed": true,
   "link": {
     "type": "generated-index",
-    "slug": "/data-products",
+    "slug": "/resources/data-products",
     "description": "A collection of guides to help you understand data products and how they work with EventCatalog."
   }
-}
+}