@eventcatalog/core 4.1.3 → 4.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +1 -1
- package/dist/analytics/log-build.js +3 -3
- package/dist/{chunk-TUKKXNQR.js → chunk-B3HQOT3D.js} +1 -1
- package/dist/{chunk-PDQER3NQ.js → chunk-CAYWT7E4.js} +1 -1
- package/dist/{chunk-DDGOJV25.js → chunk-RAB6LGHN.js} +1 -1
- package/dist/{chunk-G3D7IZ67.js → chunk-TCK7WEEE.js} +1 -1
- package/dist/{chunk-WEDJTUSQ.js → chunk-ZLQUICJD.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/api/02-config.md +166 -14
- package/dist/docs/api/08-code-blocks.md +1 -1
- package/dist/docs/development/00-why-eventcatalog.md +29 -40
- package/dist/docs/development/01-fundamentals.md +58 -7
- package/dist/docs/development/01-getting-started/configuration-overview.md +1 -93
- package/dist/docs/development/01-getting-started/develop-and-build.md +4 -3
- package/dist/docs/development/01-getting-started/installation.md +3 -3
- package/dist/docs/development/01-getting-started/project-structure.md +74 -141
- package/dist/docs/development/ask-your-architecture/01-intro.md +8 -76
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/01-what-is-eventcatalog-assistant.md +4 -3
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/02-configuration.md +2 -1
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/03-bring-your-own-tools.md +1 -3
- package/dist/docs/development/ask-your-architecture/02-eventcatalog-assistant/_category_.json +2 -2
- package/dist/docs/development/{developer-tools/llms.txt.md → ask-your-architecture/02-llms.txt.md} +1 -2
- package/dist/docs/development/ask-your-architecture/03-mcp-server/_category_.json +2 -2
- package/dist/docs/development/ask-your-architecture/03-mcp-server/getting-started.md +2 -2
- package/dist/docs/development/ask-your-architecture/03-mcp-server/introduction.md +2 -25
- package/dist/docs/development/{developer-tools/schemas.txt.md → ask-your-architecture/03-schemas.txt.md} +1 -2
- package/dist/docs/development/ask-your-architecture/04-agents/01-overview.md +27 -0
- package/dist/docs/development/ask-your-architecture/04-agents/02-code-to-docs.md +124 -0
- package/dist/docs/development/ask-your-architecture/04-agents/03-breaking-changes.md +170 -0
- package/dist/docs/development/ask-your-architecture/04-agents/_category_.json +12 -0
- package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/_category_.json +2 -2
- package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/03-installation.md +1 -1
- package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/_category_.json +2 -1
- package/dist/docs/development/ask-your-architecture/_category_.json +2 -2
- package/dist/docs/development/authentication/01-introduction.md +3 -3
- package/dist/docs/development/authentication/02-enabling-authentication.md +2 -2
- package/dist/docs/development/authentication/providers/03-setting-up-github.md +25 -1
- package/dist/docs/development/authentication/providers/03a-setting-up-google.md +0 -1
- package/dist/docs/development/bring-your-own-documentation/01-introduction.md +29 -25
- package/dist/docs/development/bring-your-own-documentation/custom-pages/01-introduction.md +9 -8
- package/dist/docs/development/bring-your-own-documentation/custom-pages/02-adding-custom-docs.md +70 -32
- package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +4 -1
- package/dist/docs/development/bring-your-own-documentation/custom-pages/04-owners.md +2 -1
- package/dist/docs/development/bring-your-own-documentation/custom-pages/_category_.json +1 -1
- package/dist/docs/development/bring-your-own-documentation/diagrams/01-introduction.md +56 -0
- package/dist/docs/development/bring-your-own-documentation/diagrams/02-creating-diagrams.md +262 -0
- package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/03-referencing-diagrams.md +3 -87
- package/dist/docs/development/bring-your-own-documentation/diagrams/05-comparing-diagrams.md +25 -0
- package/dist/docs/development/bring-your-own-documentation/diagrams/07-reference.md +144 -0
- package/dist/docs/development/{guides → bring-your-own-documentation}/diagrams/_category_.json +2 -1
- package/dist/docs/development/bring-your-own-documentation/resource-docs/01-introduction.md +2 -4
- package/dist/docs/development/bring-your-own-documentation/resource-docs/02-adding-resource-docs.md +138 -43
- package/dist/docs/development/bring-your-own-documentation/resource-docs/03-categories.md +38 -9
- package/dist/docs/development/bring-your-own-documentation/resource-docs/04-versioning.md +62 -13
- package/dist/docs/development/components/04-snippets.md +0 -2
- package/dist/docs/development/components/05-using-components.md +4 -16
- package/dist/docs/development/components/07-resource-references.md +1 -1
- package/dist/docs/development/components/_category_.json +3 -3
- package/dist/docs/development/components/components/01-accordian.md +1 -1
- package/dist/docs/development/components/components/03-admonitions.md +1 -1
- package/dist/docs/development/components/components/04-agent-tools.md +2 -2
- package/dist/docs/development/components/components/05-attachments.md +1 -1
- package/dist/docs/development/components/components/07-design.md +1 -2
- package/dist/docs/development/components/components/08-entitymap.md +2 -2
- package/dist/docs/development/components/components/09-flow.md +1 -1
- package/dist/docs/development/components/components/10-link.md +1 -1
- package/dist/docs/development/components/components/11-mermaid-file-loader.md +1 -1
- package/dist/docs/development/components/components/12-message-table.md +1 -1
- package/dist/docs/development/components/components/13-nodegraph.md +1 -1
- package/dist/docs/development/components/components/14-openapi.md +3 -3
- package/dist/docs/development/components/components/15-prompt.md +2 -6
- package/dist/docs/development/components/components/16-remote-schema.md +5 -3
- package/dist/docs/development/components/components/17-resource-group-table.md +1 -1
- package/dist/docs/development/components/components/18-resource-link.md +1 -1
- package/dist/docs/development/components/components/19-schema.md +1 -1
- package/dist/docs/development/components/components/20-schema-viewer.md +1 -1
- package/dist/docs/development/components/components/21-steps.md +1 -1
- package/dist/docs/development/components/components/22-tabs.md +1 -1
- package/dist/docs/development/components/components/23-tiles.md +1 -1
- package/dist/docs/development/components/components/24-visibility.md +1 -1
- package/dist/docs/development/components/components/_category_.json +1 -1
- package/dist/docs/development/components/custom-components/01-introduction.md +74 -0
- package/dist/docs/development/components/custom-components/02-create-your-first-component.md +71 -0
- package/dist/docs/development/components/custom-components/03-pass-data-into-components.md +86 -0
- package/dist/docs/development/components/custom-components/04-fetch-data-in-components.md +191 -0
- package/dist/docs/development/components/custom-components/05-style-components.md +60 -0
- package/dist/docs/development/components/custom-components/06-add-client-side-scripts.md +67 -0
- package/dist/docs/development/components/custom-components/07-reference.md +115 -0
- package/dist/docs/development/components/custom-components/_category_.json +11 -0
- package/dist/docs/development/components/{external-diagram-embeds/03-drawio.md → diagram-syntax/01-drawio.md} +2 -3
- package/dist/docs/development/components/{external-diagram-embeds/04-figjam.md → diagram-syntax/02-figjam.md} +1 -2
- package/dist/docs/development/components/diagram-syntax/{04-icepanel.md → 03-icepanel.md} +1 -2
- package/dist/docs/development/components/diagram-syntax/04-likec4.md +136 -0
- package/dist/docs/development/components/{external-diagram-embeds/02-lucid.md → diagram-syntax/05-lucid.md} +2 -3
- package/dist/docs/development/components/diagram-syntax/{01-mermaid.md → 06-mermaid.md} +1 -1
- package/dist/docs/development/components/{external-diagram-embeds/01-miro.md → diagram-syntax/07-miro.md} +2 -3
- package/dist/docs/development/components/diagram-syntax/{02-plantuml.md → 08-plantuml.md} +3 -3
- package/dist/docs/development/components/diagram-syntax/{03-structurizr.md → 09-structurizr.md} +1 -1
- package/dist/docs/development/components/diagram-syntax/_category_.json +3 -3
- package/dist/docs/development/customization/01-customize-landing-page.md +7 -15
- package/dist/docs/development/customization/02-themes.md +1 -0
- package/dist/docs/development/customization/03-application-sidebar.md +246 -0
- package/dist/docs/development/customization/03-search.md +2 -2
- package/dist/docs/development/customization/{customize-sidebars/01-documentation-sidebar.md → 04-documentation-sidebar.md} +4 -4
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/01-introduction.md +94 -0
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/02-create-a-custom-page.md +177 -0
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/03-create-an-api-route.md +128 -0
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/04-reference.md +138 -0
- package/dist/docs/development/customization/05-custom-pages-and-api-routes/_category_.json +12 -0
- package/dist/docs/development/customization/06-customize-tables.md +3 -3
- package/dist/docs/development/customization/07-resource-icons.md +190 -0
- package/dist/docs/development/customization/_category_.json +1 -1
- package/dist/docs/development/customization/customize-visualizer/_category_.json +2 -2
- package/dist/docs/development/deployment/hosting-options.md +1 -2
- package/dist/docs/development/developer-tools/api-catalog.md +1 -1
- package/dist/docs/development/developer-tools/eventcatalog-linter.md +137 -2
- package/dist/docs/development/governance/_category_.json +1 -0
- package/dist/docs/development/governance/architecture-change-detection/01-introduction.md +2 -2
- package/dist/docs/development/guides/98-versioning-resources.md +192 -0
- package/dist/docs/development/guides/99-adding-analytics.md +0 -1
- package/dist/docs/development/guides/changelogs/02-adding-changelogs.md +2 -2
- package/dist/docs/development/guides/changelogs/03-automated-changelogs.md +2 -2
- package/dist/docs/development/guides/changelogs/04-reference.md +77 -0
- package/dist/docs/development/guides/changelogs/_category_.json +2 -2
- package/dist/docs/development/guides/domains/01-introduction.md +14 -9
- package/dist/docs/development/guides/domains/{02-creating-domains/02-adding-domains.md → 02-create-domain.md} +32 -16
- package/dist/docs/development/guides/domains/{02-creating-domains/02a-subdomains.md → 03-model-subdomains.md} +22 -10
- package/dist/docs/development/guides/domains/03-ownership-and-language/01-owners.md +1 -1
- package/dist/docs/development/guides/domains/03-ownership-and-language/02-adding-ubiquitous-language.md +2 -6
- package/dist/docs/development/guides/domains/03-ownership-and-language/_category_.json +2 -2
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/01-add-systems-to-domains.md +154 -0
- package/dist/docs/development/guides/domains/{02-creating-domains/03-adding-services-to-domains.md → 04-add-resources-to-domains/02-add-services-to-domains.md} +6 -37
- package/dist/docs/development/guides/domains/{02-creating-domains/04-adding-messages-to-domains.md → 04-add-resources-to-domains/03-add-messages-to-domains.md} +4 -6
- package/dist/docs/development/guides/domains/{02-creating-domains/05-adding-data-products-to-domains.md → 04-add-resources-to-domains/04-add-data-products-to-domains.md} +6 -5
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/05-add-entities-to-domains.md +115 -0
- package/dist/docs/development/guides/domains/04-add-resources-to-domains/_category_.json +11 -0
- package/dist/docs/development/guides/domains/{08-domain-integration-map.md → 06-visualize-domains/01-domain-integration-map.md} +5 -6
- package/dist/docs/development/guides/domains/06-visualize-domains/_category_.json +12 -0
- package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/01-versioning.md → 07-version-domains.md} +5 -6
- package/dist/docs/development/guides/domains/{04-versioning-and-changelogs/02-changelog.md → 08-add-changelog.md} +6 -7
- package/dist/docs/development/guides/domains/09-reference.md +517 -0
- package/dist/docs/development/guides/owners/01-what-are-teams-and-users.md +46 -0
- package/dist/docs/development/guides/owners/02-create-team.md +110 -0
- package/dist/docs/development/guides/owners/03-create-user.md +99 -0
- package/dist/docs/development/guides/owners/05-teams-reference.md +144 -0
- package/dist/docs/development/guides/owners/06-users-reference.md +128 -0
- package/dist/docs/development/guides/owners/_category_.json +2 -2
- package/dist/docs/development/guides/owners/automated-teams-and-users/_category_.json +11 -0
- package/dist/docs/development/guides/owners/automated-teams-and-users/create-your-own-connector.md +108 -0
- package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-github.md +156 -0
- package/dist/docs/development/guides/owners/automated-teams-and-users/sync-from-microsoft-entra.md +253 -0
- package/dist/docs/development/guides/resources/_category_.json +11 -0
- package/dist/docs/development/guides/resources/adrs/01-introduction.md +37 -0
- package/dist/docs/development/guides/resources/adrs/02-creating-adrs.md +211 -0
- package/dist/docs/development/guides/resources/adrs/03-linking-resources.md +52 -0
- package/dist/docs/development/guides/resources/adrs/04-relationships.md +80 -0
- package/dist/docs/development/guides/resources/adrs/06-reference.md +247 -0
- package/dist/docs/development/guides/resources/adrs/_category_.json +11 -0
- package/dist/docs/development/guides/{agents → resources/agents}/01-introduction.md +1 -16
- package/dist/docs/development/guides/resources/agents/02-create-agent.md +188 -0
- package/dist/docs/development/guides/{agents → resources/agents}/03-adding-tools.md +3 -4
- package/dist/docs/development/guides/{agents → resources/agents}/04-model-metadata.md +2 -2
- package/dist/docs/development/guides/{agents/adding-to-agents/01-messages.md → resources/agents/05-add-messages-to-agents.md} +5 -4
- package/dist/docs/development/guides/{agents/adding-to-agents/02-datastores.md → resources/agents/06-add-data-stores-to-agents.md} +4 -15
- package/dist/docs/development/guides/resources/agents/11-reference.md +238 -0
- package/dist/docs/development/guides/{agents → resources/agents}/_category_.json +2 -2
- package/dist/docs/development/guides/resources/data/01-introduction.md +15 -0
- package/dist/docs/development/guides/resources/data/02-adding-data.md +184 -0
- package/dist/docs/development/guides/resources/data/03-add-read-write-relationships.md +128 -0
- package/dist/docs/development/guides/resources/data/04-reference.md +211 -0
- package/dist/docs/development/guides/{data → resources/data}/_category_.json +3 -3
- package/dist/docs/development/guides/{data-products → resources/data-products}/01-introduction.md +1 -17
- package/dist/docs/development/guides/resources/data-products/02-adding-data-products.md +174 -0
- package/dist/docs/development/guides/{data-products → resources/data-products}/03-inputs-and-outputs.md +4 -6
- package/dist/docs/development/guides/{data-products → resources/data-products}/04-contracts.md +2 -4
- package/dist/docs/development/guides/resources/data-products/07-reference.md +201 -0
- package/dist/docs/development/guides/{data-products → resources/data-products}/_category_.json +3 -3
- package/dist/docs/development/guides/resources/entities/01-introduction.md +26 -0
- package/dist/docs/development/guides/resources/entities/02-create-entity.md +162 -0
- package/dist/docs/development/guides/resources/entities/03-model-entity-relationships.md +115 -0
- package/dist/docs/development/guides/resources/entities/04-add-entities-to-resources.md +188 -0
- package/dist/docs/development/guides/resources/entities/05-entity-maps.md +48 -0
- package/dist/docs/development/guides/resources/entities/06-reference.md +273 -0
- package/dist/docs/development/guides/{domains/05-entities → resources/entities}/_category_.json +4 -4
- package/dist/docs/development/guides/resources/flows/01-introduction.md +28 -0
- package/dist/docs/development/guides/resources/flows/02-create-flow.md +304 -0
- package/dist/docs/development/guides/{flows/03-flow-nodes.md → resources/flows/03-model-flow-steps.md} +6 -6
- package/dist/docs/development/guides/resources/flows/04-add-flows-to-resources.md +149 -0
- package/dist/docs/development/guides/resources/flows/06-reference.md +226 -0
- package/dist/docs/development/guides/{flows → resources/flows}/_category_.json +3 -3
- package/dist/docs/development/guides/resources/messages/01-what-are-messages.md +104 -0
- package/dist/docs/development/guides/{messages/events/01-introduction.md → resources/messages/02-message-types/01-events.md} +3 -7
- package/dist/docs/development/guides/{messages/commands/01-introduction.md → resources/messages/02-message-types/02-commands.md} +4 -7
- package/dist/docs/development/guides/resources/messages/02-message-types/03-queries.md +20 -0
- package/dist/docs/development/guides/resources/messages/02-message-types/_category_.json +11 -0
- package/dist/docs/development/guides/resources/messages/03-create-messages/01-create-event.md +137 -0
- package/dist/docs/development/guides/resources/messages/03-create-messages/02-create-command.md +156 -0
- package/dist/docs/development/guides/resources/messages/03-create-messages/03-create-query.md +158 -0
- package/dist/docs/development/guides/{messages/common/02-draft-messages.md → resources/messages/03-create-messages/04-create-draft-message.md} +5 -7
- package/dist/docs/development/guides/resources/messages/03-create-messages/_category_.json +11 -0
- package/dist/docs/development/guides/resources/messages/04-connect-messages/01-map-producers-and-consumers.md +32 -0
- package/dist/docs/development/guides/resources/messages/04-connect-messages/02-shared-messages-across-boundaries.md +170 -0
- package/dist/docs/development/guides/{messages/common/09-grouping-messages.md → resources/messages/04-connect-messages/03-group-messages.md} +2 -4
- package/dist/docs/development/guides/resources/messages/04-connect-messages/_category_.json +11 -0
- package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/01-introduction.md +4 -28
- package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/02-adding-channels.md +77 -62
- package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/04-adding-messages-to-services.md +10 -14
- package/dist/docs/development/guides/resources/messages/04-message-channels/05-reference.md +177 -0
- package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/_category_.json +3 -3
- package/dist/docs/development/guides/{messages/common/04-versioning.md → resources/messages/08-versioning-and-lifecycle/01-version-messages.md} +39 -4
- package/dist/docs/development/guides/{messages/common/05-changelog.md → resources/messages/08-versioning-and-lifecycle/02-add-changelog.md} +5 -6
- package/dist/docs/development/guides/{messages/common/02-deprecating.md → resources/messages/08-versioning-and-lifecycle/03-deprecate-messages.md} +4 -4
- package/dist/docs/development/guides/resources/messages/08-versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/guides/{messages/common/02-examples.md → resources/messages/09-add-usage-examples.md} +59 -22
- package/dist/docs/development/guides/resources/messages/10-reference.md +439 -0
- package/dist/docs/development/guides/resources/messages/_category_.json +11 -0
- package/dist/docs/development/guides/resources/schemas/01-what-are-schemas-and-specifications.md +25 -0
- package/dist/docs/development/guides/resources/schemas/02-add-schemas-to-messages.md +63 -0
- package/dist/docs/development/guides/resources/schemas/03-add-schemas-to-data-stores.md +90 -0
- package/dist/docs/development/guides/{services/adding-to-services/04-openapi.md → resources/schemas/03-add-specifications-to-services/01-add-openapi-specifications.md} +33 -24
- package/dist/docs/development/guides/{services/adding-to-services/05-asyncapi.md → resources/schemas/03-add-specifications-to-services/02-add-asyncapi-specifications.md} +33 -23
- package/dist/docs/development/guides/{services/adding-to-services/06-graphql.md → resources/schemas/03-add-specifications-to-services/03-add-graphql-schemas.md} +36 -26
- package/dist/docs/development/guides/resources/schemas/03-add-specifications-to-services/_category_.json +11 -0
- package/dist/docs/development/guides/{schemas/02-schema-explorer.md → resources/schemas/04-explore-schemas/01-schema-explorer.md} +3 -26
- package/dist/docs/development/guides/{schemas/06-fields-explorer.md → resources/schemas/04-explore-schemas/02-fields-explorer.md} +8 -10
- package/dist/docs/development/guides/{schemas/05-field-usage.md → resources/schemas/04-explore-schemas/03-consumer-field-usage.md} +1 -3
- package/dist/docs/development/guides/resources/schemas/04-explore-schemas/_category_.json +11 -0
- package/dist/docs/development/guides/{schemas/03-schema-api.md → resources/schemas/05-schema-api.md} +6 -11
- package/dist/docs/development/guides/{schemas/04-schema-mcp.md → resources/schemas/06-schema-mcp.md} +5 -6
- package/dist/docs/development/guides/resources/schemas/07-reference.md +23 -0
- package/dist/docs/development/guides/{schemas → resources/schemas}/_category_.json +3 -3
- package/dist/docs/development/guides/resources/services/01-introduction.md +27 -0
- package/dist/docs/development/guides/resources/services/02-create-service.md +195 -0
- package/dist/docs/development/guides/resources/services/03-create-external-service.md +52 -0
- package/dist/docs/development/guides/resources/services/04-add-resources-to-services/01-add-messages-to-services.md +142 -0
- package/dist/docs/development/guides/resources/services/04-add-resources-to-services/02-add-data-stores-to-services.md +45 -0
- package/dist/docs/development/guides/{services/adding-to-services/03-entities.md → resources/services/04-add-resources-to-services/03-add-entities-to-services.md} +7 -11
- package/dist/docs/development/guides/resources/services/04-add-resources-to-services/_category_.json +11 -0
- package/dist/docs/development/guides/{services/ownership-and-components/01-owners.md → resources/services/06-ownership-and-components/01-add-service-owners.md} +3 -4
- package/dist/docs/development/guides/{services/ownership-and-components/02-components.md → resources/services/06-ownership-and-components/02-use-components.md} +4 -4
- package/dist/docs/development/guides/resources/services/06-ownership-and-components/_category_.json +11 -0
- package/dist/docs/development/guides/{services/versioning-and-lifecycle/01-versioning.md → resources/services/07-versioning-and-lifecycle/01-version-services.md} +4 -3
- package/dist/docs/development/guides/{services/versioning-and-lifecycle/02-changelog.md → resources/services/07-versioning-and-lifecycle/02-add-changelog.md} +5 -5
- package/dist/docs/development/guides/{services/versioning-and-lifecycle/03-deprecating.md → resources/services/07-versioning-and-lifecycle/03-deprecate-services.md} +5 -4
- package/dist/docs/development/guides/resources/services/07-versioning-and-lifecycle/_category_.json +11 -0
- package/dist/docs/development/guides/resources/services/08-reference.md +295 -0
- package/dist/docs/development/guides/{services → resources/services}/_category_.json +3 -3
- package/dist/docs/development/guides/systems/01-introduction.md +119 -0
- package/dist/docs/development/guides/systems/02-create-system.md +127 -0
- package/dist/docs/development/guides/systems/03-add-resources-to-systems.md +157 -0
- package/dist/docs/development/guides/systems/04-model-relationships-and-actors.md +86 -0
- package/dist/docs/development/guides/systems/05-system-context-maps.md +67 -0
- package/dist/docs/development/guides/systems/06-reference.md +329 -0
- package/dist/docs/development/guides/{messages/queries → systems}/_category_.json +5 -5
- package/dist/docs/development/license-keys/_category_.json +1 -1
- package/dist/docs/development/license-keys/integrations.md +20 -9
- package/dist/docs/development/license-keys/overview.md +7 -18
- package/dist/docs/development/license-keys/plans.md +9 -18
- package/dist/docs/development/upgrading/v2.md +1 -2
- package/dist/docs/development/upgrading/v3.md +2 -3
- package/dist/docs/development/upgrading/v4.md +377 -0
- package/dist/docs/editor/00-overview.md +3 -3
- package/dist/docs/editor/01-first-edit.md +1 -1
- package/dist/docs/editor/explanation/markdown-mdx-git.md +1 -1
- package/dist/docs/editor/how-to/add-schemas-and-specifications.md +5 -5
- package/dist/docs/editor/how-to/edit-resource.md +1 -1
- package/dist/docs/editor/how-to/use-flow-editor.md +5 -5
- package/dist/docs/editor/how-to/use-slash-commands.md +2 -2
- package/dist/docs/editor/reference/supported-content.md +2 -2
- package/dist/docs/editor/reference/supported-resources.md +14 -14
- package/dist/docs/plugins/amazon-apigateway/00-intro.md +8 -8
- package/dist/docs/plugins/amazon-apigateway/01-installation.md +10 -12
- package/dist/docs/plugins/amazon-apigateway/02-plugin-configuration.md +5 -4
- package/dist/docs/plugins/apicurio/00-intro.md +8 -8
- package/dist/docs/plugins/apicurio/01-installation.md +12 -2
- package/dist/docs/plugins/apicurio/02-plugin-configuration.md +7 -9
- package/dist/docs/plugins/apicurio/03-features.md +2 -2
- package/dist/docs/plugins/asyncapi/00-intro.md +8 -8
- package/dist/docs/plugins/asyncapi/01-installation.md +10 -11
- package/dist/docs/plugins/asyncapi/02-plugin-configuration.md +5 -5
- package/dist/docs/plugins/asyncapi/03-features.md +9 -9
- package/dist/docs/plugins/aws-glue-registry/00-intro.md +8 -8
- package/dist/docs/plugins/aws-glue-registry/00a-installation.md +16 -6
- package/dist/docs/plugins/aws-glue-registry/01-features.md +2 -2
- package/dist/docs/plugins/azure-schema-registry/00-intro.md +10 -10
- package/dist/docs/plugins/azure-schema-registry/01-installation.md +15 -5
- package/dist/docs/plugins/azure-schema-registry/02-plugin-configuration.md +4 -4
- package/dist/docs/plugins/azure-schema-registry/04-examples.md +1 -1
- package/dist/docs/plugins/backstage/00-intro.md +3 -3
- package/dist/docs/plugins/backstage/01-installation.md +7 -15
- package/dist/docs/plugins/confluent-schema-registry/00-intro.md +8 -8
- package/dist/docs/plugins/confluent-schema-registry/01-installation.md +12 -4
- package/dist/docs/plugins/confluent-schema-registry/02-plugin-configuration.md +3 -3
- package/dist/docs/plugins/eventbridge/00a-installation.md +21 -21
- package/dist/docs/plugins/eventbridge/01-features.md +3 -3
- package/dist/docs/plugins/eventbridge/03-api.md +5 -5
- package/dist/docs/plugins/eventcatalog-federation/00-introduction.md +6 -6
- package/dist/docs/plugins/eventcatalog-federation/01-installation.md +10 -11
- package/dist/docs/plugins/eventcatalog-federation/04-configuration.md +2 -2
- package/dist/docs/plugins/eventcatalog-federation/05-setup-team-catalog.md +5 -6
- package/dist/docs/plugins/github/00-intro.md +8 -8
- package/dist/docs/plugins/github/01-installation.md +12 -5
- package/dist/docs/plugins/graphql/00-intro.md +8 -8
- package/dist/docs/plugins/graphql/01-installation.md +11 -11
- package/dist/docs/plugins/graphql/02-plugin-configuration.md +3 -4
- package/dist/docs/plugins/graphql/03-features.md +4 -4
- package/dist/docs/plugins/openapi/00-intro.md +8 -8
- package/dist/docs/plugins/openapi/01-installation.md +10 -11
- package/dist/docs/plugins/openapi/02-plugin-configuration.md +7 -6
- package/dist/docs/plugins/openapi/03-features.md +6 -7
- package/dist/docs/tutorial/01-start-here.md +75 -0
- package/dist/docs/tutorial/02-install-eventcatalog.md +98 -0
- package/dist/docs/tutorial/04-add-ownership.md +184 -0
- package/dist/docs/tutorial/04-create-event.md +176 -0
- package/dist/docs/tutorial/05-create-a-domain.md +133 -0
- package/dist/docs/tutorial/05-publish-event.md +82 -0
- package/dist/docs/tutorial/06-consume-event.md +130 -0
- package/dist/docs/tutorial/06-create-a-service.md +99 -0
- package/dist/docs/tutorial/11-visualize-your-catalog.md +105 -0
- package/dist/docs/tutorial/12-build-your-catalog.md +79 -0
- package/dist/docs/tutorial/14-next-steps.md +108 -0
- package/dist/docs/tutorial/_category_.json +12 -0
- package/dist/eventcatalog.cjs +1 -1
- package/dist/eventcatalog.js +5 -5
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +4 -1
- package/eventcatalog/src/toolkit/layouts/Layout.astro +7 -1
- package/package.json +3 -3
- package/dist/docs/api/03-domain-api.md +0 -440
- package/dist/docs/api/04-service-api.md +0 -414
- package/dist/docs/api/05-command-api.md +0 -365
- package/dist/docs/api/06-event-api.md +0 -364
- package/dist/docs/api/06-query-api.md +0 -362
- package/dist/docs/api/08-channel-api.md +0 -363
- package/dist/docs/api/09-flow-api.md +0 -446
- package/dist/docs/api/10-entity-api.md +0 -330
- package/dist/docs/api/11-data-api.md +0 -273
- package/dist/docs/api/12-data-product-api.md +0 -445
- package/dist/docs/development/components/external-diagram-embeds/05-icepanel.md +0 -68
- package/dist/docs/development/components/external-diagram-embeds/_category_.json +0 -12
- package/dist/docs/development/customization/custom-components/00-what-is-mdx.md +0 -73
- package/dist/docs/development/customization/custom-components/01-introduction.md +0 -28
- package/dist/docs/development/customization/custom-components/02-adding-components.md +0 -145
- package/dist/docs/development/customization/custom-components/03-component-styling.md +0 -27
- package/dist/docs/development/customization/custom-components/04-javascript-components.md +0 -32
- package/dist/docs/development/customization/custom-components/_category_.json +0 -11
- package/dist/docs/development/customization/customize-sidebars/00-application-sidebar.md +0 -85
- package/dist/docs/development/customization/customize-sidebars/_category_.json +0 -11
- package/dist/docs/development/developer-tools/github-action.md +0 -147
- package/dist/docs/development/guides/12-customize-your-sidebar.md +0 -12
- package/dist/docs/development/guides/agents/02-adding-agents.md +0 -152
- package/dist/docs/development/guides/agents/adding-to-agents/_category_.json +0 -10
- package/dist/docs/development/guides/agents/ownership/01-owners.md +0 -67
- package/dist/docs/development/guides/agents/ownership/_category_.json +0 -11
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/01-versioning.md +0 -48
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/02-changelog.md +0 -40
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/03-deprecating.md +0 -41
- package/dist/docs/development/guides/agents/versioning-and-lifecycle/_category_.json +0 -11
- package/dist/docs/development/guides/channels/ownership-and-components/01-owners.md +0 -44
- package/dist/docs/development/guides/channels/ownership-and-components/02-components.md +0 -16
- package/dist/docs/development/guides/channels/ownership-and-components/_category_.json +0 -11
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/01-versioning.md +0 -31
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/02-changelog.md +0 -56
- package/dist/docs/development/guides/channels/versioning-and-lifecycle/_category_.json +0 -11
- package/dist/docs/development/guides/data/01-introduction.md +0 -34
- package/dist/docs/development/guides/data/02-adding-data.md +0 -86
- package/dist/docs/development/guides/data/03a-adding-schemas-to-data-stores.md +0 -73
- package/dist/docs/development/guides/data/ownership-and-components/01-owners.md +0 -45
- package/dist/docs/development/guides/data/ownership-and-components/02-components.md +0 -17
- package/dist/docs/development/guides/data/ownership-and-components/_category_.json +0 -11
- package/dist/docs/development/guides/data/versioning-and-lifecycle/01-versioning.md +0 -32
- package/dist/docs/development/guides/data/versioning-and-lifecycle/02-changelog.md +0 -57
- package/dist/docs/development/guides/data/versioning-and-lifecycle/03-deprecating.md +0 -71
- package/dist/docs/development/guides/data/versioning-and-lifecycle/_category_.json +0 -11
- package/dist/docs/development/guides/data-products/02-adding-data-products.md +0 -157
- package/dist/docs/development/guides/data-products/05-versioning.md +0 -240
- package/dist/docs/development/guides/data-products/06-adding-to-domains.md +0 -52
- package/dist/docs/development/guides/diagrams/01-introduction.md +0 -78
- package/dist/docs/development/guides/diagrams/02-creating-diagrams.md +0 -195
- package/dist/docs/development/guides/diagrams/04-versioning-diagrams.md +0 -204
- package/dist/docs/development/guides/diagrams/05-comparing-diagrams.md +0 -145
- package/dist/docs/development/guides/diagrams/06-diagrams-with-llms.md +0 -165
- package/dist/docs/development/guides/domains/02-creating-domains/_category_.json +0 -11
- package/dist/docs/development/guides/domains/04-versioning-and-changelogs/_category_.json +0 -10
- package/dist/docs/development/guides/domains/05-entities/01-introduction.md +0 -24
- package/dist/docs/development/guides/domains/05-entities/02-adding-entities.md +0 -157
- package/dist/docs/development/guides/domains/05-entities/03-adding-entities-to-domains.md +0 -30
- package/dist/docs/development/guides/domains/05-entities/04-domain-entity-map.md +0 -134
- package/dist/docs/development/guides/flows/01-introduction.md +0 -36
- package/dist/docs/development/guides/flows/02-adding-flows.md +0 -198
- package/dist/docs/development/guides/flows/04-adding-flows-to-services.md +0 -42
- package/dist/docs/development/guides/flows/05-adding-flows-to-domains.md +0 -43
- package/dist/docs/development/guides/flows/06-versioning.md +0 -27
- package/dist/docs/development/guides/flows/07-create-flow-with-ai.md +0 -171
- package/dist/docs/development/guides/messages/01-overview.md +0 -57
- package/dist/docs/development/guides/messages/_category_.json +0 -11
- package/dist/docs/development/guides/messages/commands/02-adding-commands.md +0 -131
- package/dist/docs/development/guides/messages/commands/_category_.json +0 -11
- package/dist/docs/development/guides/messages/common/01-map-to-producers-and-consumers.md +0 -37
- package/dist/docs/development/guides/messages/common/02-adding-schemas.md +0 -58
- package/dist/docs/development/guides/messages/common/03-owners.md +0 -40
- package/dist/docs/development/guides/messages/common/07-components.md +0 -12
- package/dist/docs/development/guides/messages/common/08-shared-messages-across-boundaries.md +0 -70
- package/dist/docs/development/guides/messages/common/_category_.json +0 -11
- package/dist/docs/development/guides/messages/events/02-adding-events.md +0 -130
- package/dist/docs/development/guides/messages/events/_category_.json +0 -11
- package/dist/docs/development/guides/messages/queries/01-introduction.md +0 -25
- package/dist/docs/development/guides/messages/queries/02-adding-queries.md +0 -130
- package/dist/docs/development/guides/owners/teams/01-introduction.md +0 -21
- package/dist/docs/development/guides/owners/teams/02-adding-teams.md +0 -73
- package/dist/docs/development/guides/owners/teams/_category_.json +0 -11
- package/dist/docs/development/guides/owners/users/01-introduction.md +0 -20
- package/dist/docs/development/guides/owners/users/02-adding-users.md +0 -69
- package/dist/docs/development/guides/owners/users/_category_.json +0 -11
- package/dist/docs/development/guides/schemas/01-introduction.md +0 -64
- package/dist/docs/development/guides/services/01-introduction.md +0 -33
- package/dist/docs/development/guides/services/02-adding-services.md +0 -113
- package/dist/docs/development/guides/services/03-creating-external-systems.md +0 -71
- package/dist/docs/development/guides/services/adding-to-services/01-messages.md +0 -229
- package/dist/docs/development/guides/services/adding-to-services/02-datastores.md +0 -77
- package/dist/docs/development/guides/services/adding-to-services/_category_.json +0 -10
- package/dist/docs/development/guides/services/ownership-and-components/_category_.json +0 -11
- package/dist/docs/development/guides/services/versioning-and-lifecycle/_category_.json +0 -11
- /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/01-introduction.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{04-skills → 05-skills}/02-installation.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/01-introduction.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/02-slack-app-setup.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/04-deployment.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/05-usage.md +0 -0
- /package/dist/docs/development/ask-your-architecture/{05-slack-integration → 06-slack-integration}/06-troubleshooting.md +0 -0
- /package/dist/docs/development/guides/{channels → resources/messages/04-message-channels}/09-configuration +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
sidebar_position:
|
|
2
|
+
sidebar_position: 3
|
|
3
3
|
keywords:
|
|
4
4
|
- Upgrade EventCatalog
|
|
5
5
|
sidebar_label: v3
|
|
@@ -221,7 +221,7 @@ To solve this we have introduced a new navigation system that introduces new ben
|
|
|
221
221
|
- **Fully customizable navigation system** - define your own navigation system for your catalog.
|
|
222
222
|
- **Favorited resources** - add your favorite resources to your navigation system.
|
|
223
223
|
|
|
224
|
-
You can read more about the new context aware navigation in the [documentation sidebar documentation](/docs/development/customization/
|
|
224
|
+
You can read more about the new context aware navigation in the [documentation sidebar documentation](/docs/development/customization/documentation-sidebar).
|
|
225
225
|
|
|
226
226
|
### New caching and performance improvements
|
|
227
227
|
|
|
@@ -274,4 +274,3 @@ module.exports = {
|
|
|
274
274
|
## Known issues
|
|
275
275
|
|
|
276
276
|
Please check [EventCatalog issues on GitHub](https://github.com/event-catalog/eventcatalog/issues) for any reported issues, or to file an issue yourself.
|
|
277
|
-
|
|
@@ -0,0 +1,377 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 2
|
|
3
|
+
keywords:
|
|
4
|
+
- Upgrade EventCatalog
|
|
5
|
+
sidebar_label: v4
|
|
6
|
+
title: Upgrade to EventCatalog v4
|
|
7
|
+
description: How to upgrade to EventCatalog v4.
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
import ProjectTree from '@site/src/components/MDX/ProjectTree';
|
|
11
|
+
|
|
12
|
+
This guide will help you upgrade from v3 to v4 of EventCatalog.
|
|
13
|
+
|
|
14
|
+
EventCatalog v4 introduces systems as a first-class resource, adds system context maps, updates the Discover and Application sidebar experience, moves EventCatalog onto Astro 7 internally, and removes the PDF export feature.
|
|
15
|
+
|
|
16
|
+
:::info v4 beta
|
|
17
|
+
|
|
18
|
+
The v4 branch is currently published as a beta. If v4 has not been promoted to `latest` yet, install the beta package instead of `latest`.
|
|
19
|
+
|
|
20
|
+
:::
|
|
21
|
+
|
|
22
|
+
## Upgrade EventCatalog
|
|
23
|
+
|
|
24
|
+
Update your project's version of EventCatalog using your package manager:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install @eventcatalog/core@latest
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
If you are testing the v4 beta, use the beta tag:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install @eventcatalog/core@beta
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
_Problems upgrading? [Try resetting your project](/docs/development/upgrading#having-problems)._
|
|
37
|
+
|
|
38
|
+
## Before you upgrade
|
|
39
|
+
|
|
40
|
+
Most v3 catalogs should continue to build without changing their existing resources. You do not need to move your services, messages, flows, entities, or data stores into systems to upgrade to v4.
|
|
41
|
+
|
|
42
|
+
Before upgrading, we recommend:
|
|
43
|
+
|
|
44
|
+
1. Create a branch for the upgrade.
|
|
45
|
+
1. Upgrade `@eventcatalog/core`.
|
|
46
|
+
1. Remove `.eventcatalog-core`, `node_modules`, and your lock file if the catalog does not pick up the new version.
|
|
47
|
+
1. Run your catalog locally and check custom pages, custom navigation, and visualiser links.
|
|
48
|
+
|
|
49
|
+
## Removed
|
|
50
|
+
|
|
51
|
+
The following features have now been entirely removed from the code base and can no longer be used.
|
|
52
|
+
|
|
53
|
+
### Removed: Export to PDF
|
|
54
|
+
|
|
55
|
+
The Export to PDF / print feature has been removed from EventCatalog v4.
|
|
56
|
+
|
|
57
|
+
#### What do I need to do?
|
|
58
|
+
|
|
59
|
+
Remove any user guidance, screenshots, or internal runbooks that tell people to export resource pages to PDF from EventCatalog.
|
|
60
|
+
|
|
61
|
+
Diagram version comparison is still available, and is no longer gated behind the Scale plan.
|
|
62
|
+
|
|
63
|
+
### Removed: `/visualiser/context-map`
|
|
64
|
+
|
|
65
|
+
The old global context map route has been removed.
|
|
66
|
+
|
|
67
|
+
#### What do I need to do?
|
|
68
|
+
|
|
69
|
+
If you have custom navigation, docs, or bookmarks that link to `/visualiser/context-map`, update them to the new system context map route:
|
|
70
|
+
|
|
71
|
+
```diff title="eventcatalog.config.js"
|
|
72
|
+
export default {
|
|
73
|
+
navigation: {
|
|
74
|
+
pages: [
|
|
75
|
+
{
|
|
76
|
+
type: 'item',
|
|
77
|
+
title: 'System Context Map',
|
|
78
|
+
- href: '/visualiser/context-map',
|
|
79
|
+
+ href: '/visualiser/system-context-map',
|
|
80
|
+
},
|
|
81
|
+
],
|
|
82
|
+
},
|
|
83
|
+
};
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## Breaking changes
|
|
87
|
+
|
|
88
|
+
The following changes are considered breaking changes in EventCatalog v4. Breaking changes may or may not affect your catalog depending on how much you customize EventCatalog.
|
|
89
|
+
|
|
90
|
+
### Changed: EventCatalog now uses Astro 7 internally
|
|
91
|
+
|
|
92
|
+
EventCatalog v4 upgrades the internal application from Astro 6 to Astro 7.
|
|
93
|
+
|
|
94
|
+
Most catalogs do not need to change anything. If you have custom Astro pages, custom integrations, or custom MDX/Markdown processing that depends on Astro internals, review those customizations during the upgrade.
|
|
95
|
+
|
|
96
|
+
#### What do I need to do?
|
|
97
|
+
|
|
98
|
+
If your catalog only uses EventCatalog resources and MDX content, upgrade EventCatalog and test the catalog.
|
|
99
|
+
|
|
100
|
+
If you maintain custom Astro pages or custom integrations, check them against Astro 7 behavior and run the catalog locally after upgrading.
|
|
101
|
+
|
|
102
|
+
### Changed: Application sidebar configuration has moved to `navigation.groups`
|
|
103
|
+
|
|
104
|
+
EventCatalog v4 removes the top-level `sidebar` configuration that only let you show or hide items in the Application sidebar.
|
|
105
|
+
|
|
106
|
+
You can now configure the whole Application sidebar using `navigation.groups`. This lets you define groups, labels, item order, icons, custom links, bottom-positioned groups, active route matching, and visibility.
|
|
107
|
+
|
|
108
|
+
:::info
|
|
109
|
+
|
|
110
|
+
`navigation.pages` still controls the context-aware documentation sidebar. Use `navigation.groups` for the Application sidebar.
|
|
111
|
+
|
|
112
|
+
:::
|
|
113
|
+
|
|
114
|
+
#### What do I need to do?
|
|
115
|
+
|
|
116
|
+
If you are not using the top-level `sidebar` property in `eventcatalog.config.js`, there is nothing to change.
|
|
117
|
+
|
|
118
|
+
If you are using `sidebar`, move that configuration to `navigation.groups`.
|
|
119
|
+
|
|
120
|
+
```diff title="eventcatalog.config.js"
|
|
121
|
+
export default {
|
|
122
|
+
- sidebar: [
|
|
123
|
+
- { id: '/directory/teams', visible: false },
|
|
124
|
+
- { id: '/schemas/fields', visible: false },
|
|
125
|
+
- ],
|
|
126
|
+
+ navigation: {
|
|
127
|
+
+ groups: [
|
|
128
|
+
+ {
|
|
129
|
+
+ id: 'main',
|
|
130
|
+
+ items: [{ id: 'home' }, { id: 'docs' }],
|
|
131
|
+
+ },
|
|
132
|
+
+ {
|
|
133
|
+
+ id: 'browse',
|
|
134
|
+
+ label: 'Browse',
|
|
135
|
+
+ items: [
|
|
136
|
+
+ { id: 'catalog' },
|
|
137
|
+
+ { id: 'schemas' },
|
|
138
|
+
+ { id: 'schema-insights', visible: false },
|
|
139
|
+
+ ],
|
|
140
|
+
+ },
|
|
141
|
+
+ {
|
|
142
|
+
+ id: 'organization',
|
|
143
|
+
+ label: 'Organization',
|
|
144
|
+
+ items: [{ id: 'teams', visible: false }, { id: 'users' }],
|
|
145
|
+
+ },
|
|
146
|
+
+ {
|
|
147
|
+
+ id: 'settings',
|
|
148
|
+
+ position: 'bottom',
|
|
149
|
+
+ items: [{ id: 'settings' }],
|
|
150
|
+
+ },
|
|
151
|
+
+ ],
|
|
152
|
+
+ },
|
|
153
|
+
};
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
Built-in Application sidebar item IDs include:
|
|
157
|
+
|
|
158
|
+
- `home`
|
|
159
|
+
- `docs`
|
|
160
|
+
- `catalog`
|
|
161
|
+
- `schemas`
|
|
162
|
+
- `schema-insights`
|
|
163
|
+
- `teams`
|
|
164
|
+
- `users`
|
|
165
|
+
- `settings`
|
|
166
|
+
You can also use route IDs such as `/schemas/explorer` or add custom items:
|
|
167
|
+
|
|
168
|
+
```js title="eventcatalog.config.js"
|
|
169
|
+
export default {
|
|
170
|
+
navigation: {
|
|
171
|
+
groups: [
|
|
172
|
+
{
|
|
173
|
+
id: 'platform',
|
|
174
|
+
label: 'Platform',
|
|
175
|
+
items: [
|
|
176
|
+
{
|
|
177
|
+
id: 'platform-docs',
|
|
178
|
+
label: 'Platform Docs',
|
|
179
|
+
icon: 'BookOpen',
|
|
180
|
+
href: '/docs/custom/platform/overview',
|
|
181
|
+
match: ['/docs/custom/platform'],
|
|
182
|
+
},
|
|
183
|
+
{
|
|
184
|
+
id: 'support',
|
|
185
|
+
label: 'Support',
|
|
186
|
+
icon: 'LifeBuoy',
|
|
187
|
+
href: 'https://support.example.com',
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
},
|
|
191
|
+
],
|
|
192
|
+
},
|
|
193
|
+
};
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
When `navigation.groups` is provided, it replaces the default Application sidebar groups. Add every item you want users to see.
|
|
197
|
+
|
|
198
|
+
If you import `SideBarConfig` from EventCatalog types, remove that import. It is no longer exported.
|
|
199
|
+
|
|
200
|
+
### Changed: Discover navigation has been simplified
|
|
201
|
+
|
|
202
|
+
EventCatalog v4 replaces the resource-specific Browse sidebar links with a single Discover experience and a Kind filter. Users can switch between domains, systems, services, messages, flows, entities, data stores, and other resource collections from the Discover page.
|
|
203
|
+
|
|
204
|
+

|
|
205
|
+
|
|
206
|
+
#### What do I need to do?
|
|
207
|
+
|
|
208
|
+
If you use the default Application sidebar, there is nothing to change.
|
|
209
|
+
|
|
210
|
+
If you have custom screenshots, onboarding docs, or training material that mentions the old resource-specific Browse links, update them to reference Discover and the Kind filter.
|
|
211
|
+
|
|
212
|
+
### Changed: System context maps are now the high-level architecture view
|
|
213
|
+
|
|
214
|
+
EventCatalog v4 adds dedicated system context map routes:
|
|
215
|
+
|
|
216
|
+
- `/visualiser/system-context-map` for the global system context map.
|
|
217
|
+
- `/visualiser/systems/:id/:version/context` for a single system in context.
|
|
218
|
+
- `/visualiser/domains/:id/:version/systems-context` for systems inside a domain.
|
|
219
|
+
|
|
220
|
+
The existing resource visualiser routes still work for resources such as services and domains.
|
|
221
|
+
|
|
222
|
+
#### What do I need to do?
|
|
223
|
+
|
|
224
|
+
Update any custom links that should point users to the new high-level system context map.
|
|
225
|
+
|
|
226
|
+
## New features
|
|
227
|
+
|
|
228
|
+
The following new features and improvements have been added to EventCatalog v4.
|
|
229
|
+
|
|
230
|
+
### Systems are now a first-class resource
|
|
231
|
+
|
|
232
|
+
Systems are collections of resources that work together to perform a function, such as checkout, payment processing, customer identity, or product search.
|
|
233
|
+
|
|
234
|
+
A system can group the resources that cooperate to deliver one capability, including [services](/docs/development/guides/resources/services/introduction), [flows](/docs/development/guides/resources/flows/introduction), [entities](/docs/development/guides/resources/entities/introduction), [data stores](/docs/development/guides/resources/data/introduction), [diagrams](/docs/development/bring-your-own-documentation/diagrams/introduction), and documentation.
|
|
235
|
+
|
|
236
|
+

|
|
237
|
+
|
|
238
|
+
Systems are versioned resources. You can define them at the top level of your catalog, or inside a domain when that system clearly belongs to a business boundary.
|
|
239
|
+
|
|
240
|
+
<ProjectTree
|
|
241
|
+
items={[
|
|
242
|
+
{
|
|
243
|
+
name: 'domains',
|
|
244
|
+
type: 'folder',
|
|
245
|
+
defaultOpen: true,
|
|
246
|
+
children: [
|
|
247
|
+
{
|
|
248
|
+
name: 'Payments',
|
|
249
|
+
type: 'folder',
|
|
250
|
+
defaultOpen: true,
|
|
251
|
+
children: [
|
|
252
|
+
{ name: 'index.mdx' },
|
|
253
|
+
{
|
|
254
|
+
name: 'systems',
|
|
255
|
+
type: 'folder',
|
|
256
|
+
defaultOpen: true,
|
|
257
|
+
children: [
|
|
258
|
+
{
|
|
259
|
+
name: 'payment-processing-system',
|
|
260
|
+
type: 'folder',
|
|
261
|
+
defaultOpen: true,
|
|
262
|
+
children: [
|
|
263
|
+
{ name: 'index.mdx', highlight: true },
|
|
264
|
+
{
|
|
265
|
+
name: 'services',
|
|
266
|
+
type: 'folder',
|
|
267
|
+
defaultOpen: true,
|
|
268
|
+
children: [
|
|
269
|
+
{
|
|
270
|
+
name: 'PaymentAPI',
|
|
271
|
+
type: 'folder',
|
|
272
|
+
defaultOpen: true,
|
|
273
|
+
children: [{ name: 'index.mdx' }],
|
|
274
|
+
},
|
|
275
|
+
],
|
|
276
|
+
},
|
|
277
|
+
],
|
|
278
|
+
},
|
|
279
|
+
],
|
|
280
|
+
},
|
|
281
|
+
],
|
|
282
|
+
},
|
|
283
|
+
],
|
|
284
|
+
},
|
|
285
|
+
]}
|
|
286
|
+
/>
|
|
287
|
+
|
|
288
|
+
Example system frontmatter:
|
|
289
|
+
|
|
290
|
+
```md title="domains/Payments/systems/payment-processing-system/index.mdx"
|
|
291
|
+
---
|
|
292
|
+
id: payment-processing-system
|
|
293
|
+
name: Payment Processing System
|
|
294
|
+
version: 1.0.0
|
|
295
|
+
summary: Handles payment authorization, capture, and refund processing.
|
|
296
|
+
owners:
|
|
297
|
+
- payments-platform
|
|
298
|
+
services:
|
|
299
|
+
- id: PaymentAPI
|
|
300
|
+
flows:
|
|
301
|
+
- id: CheckoutSaga
|
|
302
|
+
relationships:
|
|
303
|
+
- id: fraud-detection
|
|
304
|
+
version: 1.0.0
|
|
305
|
+
label: requests fraud checks from
|
|
306
|
+
---
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
You can also reference systems from a domain:
|
|
310
|
+
|
|
311
|
+
```md title="domains/Payments/index.mdx"
|
|
312
|
+
---
|
|
313
|
+
id: payments
|
|
314
|
+
name: Payments
|
|
315
|
+
version: 1.0.0
|
|
316
|
+
systems:
|
|
317
|
+
- id: payment-processing-system
|
|
318
|
+
version: 1.0.0
|
|
319
|
+
---
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
Read more in the [systems documentation](/docs/development/guides/systems/introduction).
|
|
323
|
+
|
|
324
|
+
### System context maps
|
|
325
|
+
|
|
326
|
+
Systems can declare relationships to other systems. EventCatalog uses those relationships to render context maps that show how systems relate to each other.
|
|
327
|
+
|
|
328
|
+
System context maps help users move from a high-level architecture view into a detailed system view. From the global map, users can click into a system, then explore the [services](/docs/development/guides/resources/services/introduction), [APIs](/docs/development/guides/resources/schemas/add-specifications-to-services/add-openapi-specifications), [messages](/docs/development/guides/resources/messages/what-are-messages), [flows](/docs/development/guides/resources/flows/introduction), [entities](/docs/development/guides/resources/entities/introduction), and [data stores](/docs/development/guides/resources/data/introduction) that make up that system.
|
|
329
|
+
|
|
330
|
+
Read more in the [system context maps documentation](/docs/development/guides/systems/system-context-maps).
|
|
331
|
+
|
|
332
|
+
### Systems in the SDK
|
|
333
|
+
|
|
334
|
+
The EventCatalog SDK now supports systems. You can read and write systems, add resources to a system, write resources directly into a system, and add systems to domains.
|
|
335
|
+
|
|
336
|
+
This is useful for generators and integrations that sync architecture information from source code, specifications, schema registries, or internal platforms.
|
|
337
|
+
|
|
338
|
+
### Systems in AI, MCP, and catalog tools
|
|
339
|
+
|
|
340
|
+
EventCatalog Assistant, MCP tools, and catalog tools now understand systems. AI workflows can retrieve systems, inspect system resources, and generate architecture diagrams for systems.
|
|
341
|
+
|
|
342
|
+
### Systems in Discover, sidebars, teams, and ADRs
|
|
343
|
+
|
|
344
|
+
Systems are now available across the catalog experience:
|
|
345
|
+
|
|
346
|
+
- Systems can be discovered on `/discover/systems`.
|
|
347
|
+
- Systems appear in sidebars with their own icon and color.
|
|
348
|
+
- Teams and users can own systems.
|
|
349
|
+
- ADRs can target systems with `appliesTo: [{ type: 'system' }]`.
|
|
350
|
+
- Resource-level documentation can be attached to systems.
|
|
351
|
+
|
|
352
|
+
### Top-level diagrams sidebar group
|
|
353
|
+
|
|
354
|
+
EventCatalog v4 adds a Top level diagrams navigation group when systems exist. This surfaces the System Context Map from the sidebar so users can start from the highest-level architecture view.
|
|
355
|
+
|
|
356
|
+
### Custom homepages are available in Community Edition
|
|
357
|
+
|
|
358
|
+
Custom homepages are now available in Community Edition. You no longer need a paid feature flag to customize the catalog homepage.
|
|
359
|
+
|
|
360
|
+
Create your custom homepage at `pages/homepage.astro`.
|
|
361
|
+
|
|
362
|
+
<ProjectTree
|
|
363
|
+
items={[
|
|
364
|
+
{
|
|
365
|
+
name: 'pages',
|
|
366
|
+
type: 'folder',
|
|
367
|
+
defaultOpen: true,
|
|
368
|
+
children: [{ name: 'homepage.astro', highlight: true }],
|
|
369
|
+
},
|
|
370
|
+
]}
|
|
371
|
+
/>
|
|
372
|
+
|
|
373
|
+
Custom homepages can also embed the new System Context Map using the `SystemContextMap` component.
|
|
374
|
+
|
|
375
|
+
## Known issues
|
|
376
|
+
|
|
377
|
+
Please check [EventCatalog issues on GitHub](https://github.com/event-catalog/eventcatalog/issues) for any reported issues, or to file an issue yourself.
|
|
@@ -15,7 +15,7 @@ It runs on your machine, opens your catalog from disk, lets you edit architectur
|
|
|
15
15
|
|
|
16
16
|
The editor is for people who maintain an EventCatalog:
|
|
17
17
|
|
|
18
|
-
- Architects documenting [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [messages](/docs/development/guides/messages/
|
|
18
|
+
- Architects documenting [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/resources/services/introduction), [messages](/docs/development/guides/resources/messages/what-are-messages), and [ownership](/docs/owners)
|
|
19
19
|
- Developers keeping resource documentation, schemas, and specifications up to date
|
|
20
20
|
- Analysts, product owners, or domain experts who can improve catalog content but do not want to edit MDX files directly
|
|
21
21
|
|
|
@@ -32,10 +32,10 @@ These docs assume you already have an EventCatalog project. If you are just gett
|
|
|
32
32
|
Use EventCatalog Editor to:
|
|
33
33
|
|
|
34
34
|
- Open a local EventCatalog project
|
|
35
|
-
- Browse [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [messages](/docs/development/guides/messages/
|
|
35
|
+
- Browse [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/resources/services/introduction), [messages](/docs/development/guides/resources/messages/what-are-messages), [channels](/docs/development/guides/resources/messages/message-channels/introduction), [entities](/docs/development/guides/resources/entities/introduction), [data stores](/docs/development/guides/resources/data/introduction), [flows](/docs/development/guides/resources/flows/introduction), [users](/docs/development/guides/owners/what-are-teams-and-users), and [teams](/docs/development/guides/owners/what-are-teams-and-users)
|
|
36
36
|
- Edit documentation in a rich editor or source editor
|
|
37
37
|
- Update common frontmatter fields through forms
|
|
38
|
-
- Add schemas to [events](/docs/development/guides/messages/events
|
|
38
|
+
- Add schemas to [events](/docs/development/guides/resources/messages/message-types/events), [commands](/docs/development/guides/resources/messages/message-types/commands), and [queries](/docs/development/guides/resources/messages/message-types/queries)
|
|
39
39
|
- Add OpenAPI, AsyncAPI, and GraphQL specifications to domains and services
|
|
40
40
|
- Preview resources in a running EventCatalog site
|
|
41
41
|
- Inspect local Git changes, view diffs, revert files, and commit work
|
|
@@ -69,7 +69,7 @@ If the editor asks you to sign in, sign in with [EventCatalog Cloud](https://eve
|
|
|
69
69
|
|
|
70
70
|
## Open a resource
|
|
71
71
|
|
|
72
|
-
Choose a resource from the left navigation. A good first edit is a [service](/docs/development/guides/services/introduction), [domain](/docs/development/guides/domains/introduction), [event](/docs/development/guides/messages/events
|
|
72
|
+
Choose a resource from the left navigation. A good first edit is a [service](/docs/development/guides/resources/services/introduction), [domain](/docs/development/guides/domains/introduction), [event](/docs/development/guides/resources/messages/message-types/events), [command](/docs/development/guides/resources/messages/message-types/commands), or [query](/docs/development/guides/resources/messages/message-types/queries) that already exists in your catalog.
|
|
73
73
|
|
|
74
74
|
The editor shows:
|
|
75
75
|
|
|
@@ -13,7 +13,7 @@ Instead of asking every contributor to edit Markdown, MDX, YAML frontmatter, sch
|
|
|
13
13
|
|
|
14
14
|
Each EventCatalog resource is still represented by files in your catalog.
|
|
15
15
|
|
|
16
|
-
For example, a [service](/docs/development/guides/services/introduction) might live at:
|
|
16
|
+
For example, a [service](/docs/development/guides/resources/services/introduction) might live at:
|
|
17
17
|
|
|
18
18
|
```txt
|
|
19
19
|
domains/Orders/services/OrderService/index.mdx
|
|
@@ -11,9 +11,9 @@ Use schemas and specifications to keep implementation contracts close to the arc
|
|
|
11
11
|
|
|
12
12
|
Schemas are supported on:
|
|
13
13
|
|
|
14
|
-
- [Events](/docs/development/guides/messages/events
|
|
15
|
-
- [Commands](/docs/development/guides/messages/commands
|
|
16
|
-
- [Queries](/docs/development/guides/messages/queries
|
|
14
|
+
- [Events](/docs/development/guides/resources/messages/message-types/events)
|
|
15
|
+
- [Commands](/docs/development/guides/resources/messages/message-types/commands)
|
|
16
|
+
- [Queries](/docs/development/guides/resources/messages/message-types/queries)
|
|
17
17
|
|
|
18
18
|
Open the message resource, then use the **Schema** section to add or edit the schema file.
|
|
19
19
|
|
|
@@ -33,7 +33,7 @@ If the schema editor does not expose the exact change you need yet, use source m
|
|
|
33
33
|
Specifications are supported on:
|
|
34
34
|
|
|
35
35
|
- [Domains](/docs/development/guides/domains/introduction)
|
|
36
|
-
- [Services](/docs/development/guides/services/introduction)
|
|
36
|
+
- [Services](/docs/development/guides/resources/services/introduction)
|
|
37
37
|
|
|
38
38
|
Open the domain or service, then use the specifications area to add:
|
|
39
39
|
|
|
@@ -63,4 +63,4 @@ Use source mode when you need to:
|
|
|
63
63
|
- Add custom MDX around a schema
|
|
64
64
|
- Edit specification metadata the visual form does not expose yet
|
|
65
65
|
|
|
66
|
-
For more on schema documentation in EventCatalog, see the [schema documentation guides](/docs/development/guides/schemas/
|
|
66
|
+
For more on schema documentation in EventCatalog, see the [schema documentation guides](/docs/development/guides/resources/schemas/what-are-schemas-and-specifications).
|
|
@@ -11,7 +11,7 @@ Use this guide when you want to update a resource that already exists in your ca
|
|
|
11
11
|
|
|
12
12
|
Start the editor and choose a resource from the resource list.
|
|
13
13
|
|
|
14
|
-
The editor supports common EventCatalog resource types, including [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/services/introduction), [events](/docs/development/guides/messages/events
|
|
14
|
+
The editor supports common EventCatalog resource types, including [domains](/docs/development/guides/domains/introduction), [services](/docs/development/guides/resources/services/introduction), [events](/docs/development/guides/resources/messages/message-types/events), [commands](/docs/development/guides/resources/messages/message-types/commands), [queries](/docs/development/guides/resources/messages/message-types/queries), [channels](/docs/development/guides/resources/messages/message-channels/introduction), [entities](/docs/development/guides/resources/entities/introduction), [data stores](/docs/development/guides/resources/data/introduction), [flows](/docs/development/guides/resources/flows/introduction), [users](/docs/development/guides/owners/what-are-teams-and-users), and [teams](/docs/development/guides/owners/what-are-teams-and-users).
|
|
15
15
|
|
|
16
16
|

|
|
17
17
|
|
|
@@ -5,7 +5,7 @@ title: Use the Flow Editor
|
|
|
5
5
|
description: Create and update EventCatalog flows visually with EventCatalog Editor.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
Use the Flow Editor when you want to document a business process, user journey, or architecture workflow without editing the [flow](/docs/development/guides/flows/introduction) files by hand.
|
|
8
|
+
Use the Flow Editor when you want to document a business process, user journey, or architecture workflow without editing the [flow](/docs/development/guides/resources/flows/introduction) files by hand.
|
|
9
9
|
|
|
10
10
|
Flow resources are still stored in your local EventCatalog project. The editor gives you a visual way to create and arrange the steps, then writes the change back to your catalog files.
|
|
11
11
|
|
|
@@ -33,10 +33,10 @@ Use the node picker to add the resource that best represents the next step.
|
|
|
33
33
|
|
|
34
34
|
For example:
|
|
35
35
|
|
|
36
|
-
- Add a [service](/docs/development/guides/services/introduction) when a system performs work
|
|
37
|
-
- Add an [event](/docs/development/guides/messages/events
|
|
38
|
-
- Add a [command](/docs/development/guides/messages/commands
|
|
39
|
-
- Add a [query](/docs/development/guides/messages/queries
|
|
36
|
+
- Add a [service](/docs/development/guides/resources/services/introduction) when a system performs work
|
|
37
|
+
- Add an [event](/docs/development/guides/resources/messages/message-types/events) when something has happened
|
|
38
|
+
- Add a [command](/docs/development/guides/resources/messages/message-types/commands) when one system asks another system to do something
|
|
39
|
+
- Add a [query](/docs/development/guides/resources/messages/message-types/queries) when the flow reads information
|
|
40
40
|
|
|
41
41
|
Use existing catalog resources when they already exist. Create new resources when the flow reveals something that is missing from the catalog.
|
|
42
42
|
|
|
@@ -32,7 +32,7 @@ You can insert components such as:
|
|
|
32
32
|
- Draw.io diagram
|
|
33
33
|
- Lucid diagram
|
|
34
34
|
- IcePanel diagram
|
|
35
|
-
- [Flow](/docs/development/guides/flows/introduction)
|
|
35
|
+
- [Flow](/docs/development/guides/resources/flows/introduction)
|
|
36
36
|
- Mermaid diagram
|
|
37
37
|
- Entity Map
|
|
38
38
|
- Schema Viewer
|
|
@@ -43,7 +43,7 @@ You can insert components such as:
|
|
|
43
43
|
- Visibility
|
|
44
44
|
- Admonitions such as note, tip, warning, danger, and info
|
|
45
45
|
|
|
46
|
-
Some commands are available only when they make sense for the current resource. For example, **Schema Viewer** is available for [events](/docs/development/guides/messages/events
|
|
46
|
+
Some commands are available only when they make sense for the current resource. For example, **Schema Viewer** is available for [events](/docs/development/guides/resources/messages/message-types/events), [commands](/docs/development/guides/resources/messages/message-types/commands), and [queries](/docs/development/guides/resources/messages/message-types/queries), while **Entity Map** is available for [domains](/docs/development/guides/domains/introduction).
|
|
47
47
|
|
|
48
48
|
## Use visual previews
|
|
49
49
|
|
|
@@ -36,11 +36,11 @@ Common command groups include:
|
|
|
36
36
|
- Lists: bullet and ordered lists
|
|
37
37
|
- Advanced: code blocks, dividers, and tables
|
|
38
38
|
- Admonitions: note, tip, warning, danger, and info callouts
|
|
39
|
-
- Diagrams: Node Graph, [Flow](/docs/development/guides/flows/introduction), Mermaid, Miro, Draw.io, Lucid, IcePanel, Entity Map, and Schema Viewer
|
|
39
|
+
- Diagrams: Node Graph, [Flow](/docs/development/guides/resources/flows/introduction), Mermaid, Miro, Draw.io, Lucid, IcePanel, Entity Map, and Schema Viewer
|
|
40
40
|
- Layout: Steps, Tiles, and Accordion group
|
|
41
41
|
- AI: Prompt and Visibility blocks
|
|
42
42
|
|
|
43
|
-
Some commands are resource-aware. For example, Schema Viewer appears for [events](/docs/development/guides/messages/events
|
|
43
|
+
Some commands are resource-aware. For example, Schema Viewer appears for [events](/docs/development/guides/resources/messages/message-types/events), [commands](/docs/development/guides/resources/messages/message-types/commands), and [queries](/docs/development/guides/resources/messages/message-types/queries), and Entity Map appears for [domains](/docs/development/guides/domains/introduction).
|
|
44
44
|
|
|
45
45
|
## Source mode
|
|
46
46
|
|
|
@@ -10,31 +10,31 @@ EventCatalog Editor can browse and edit the main EventCatalog resource types.
|
|
|
10
10
|
| Resource type | Browse | Edit docs | Edit metadata | Create | Delete | Notes |
|
|
11
11
|
| --- | --- | --- | --- | --- | --- | --- |
|
|
12
12
|
| [Domain](/docs/development/guides/domains/introduction) | Yes | Yes | Yes | Yes | Yes | Supports services, messages, entities, specifications, and ubiquitous language |
|
|
13
|
-
| [Service](/docs/development/guides/services/introduction) | Yes | Yes | Yes | Yes | Yes | Supports message relationships, data store relationships, and specifications |
|
|
14
|
-
| [Event](/docs/development/guides/messages/events
|
|
15
|
-
| [Command](/docs/development/guides/messages/commands
|
|
16
|
-
| [Query](/docs/development/guides/messages/queries
|
|
17
|
-
| [Channel](/docs/development/guides/channels/introduction) | Yes | Yes | Yes | Yes | Yes | Supports common metadata |
|
|
18
|
-
| [Entity](/docs/development/guides/
|
|
19
|
-
| [Data store](/docs/development/guides/data/introduction) | Yes | Yes | Yes | Yes | Yes | Represented as EventCatalog container resources |
|
|
20
|
-
| [Flow](/docs/development/guides/flows/introduction) | Yes | Yes | Yes | Yes | Yes | Supports flow step editing |
|
|
21
|
-
| [User](/docs/development/guides/owners/users
|
|
22
|
-
| [Team](/docs/development/guides/owners/teams
|
|
13
|
+
| [Service](/docs/development/guides/resources/services/introduction) | Yes | Yes | Yes | Yes | Yes | Supports message relationships, data store relationships, and specifications |
|
|
14
|
+
| [Event](/docs/development/guides/resources/messages/message-types/events) | Yes | Yes | Yes | Yes | Yes | Supports schemas and producer/consumer relationships |
|
|
15
|
+
| [Command](/docs/development/guides/resources/messages/message-types/commands) | Yes | Yes | Yes | Yes | Yes | Supports schemas, operations, and producer/consumer relationships |
|
|
16
|
+
| [Query](/docs/development/guides/resources/messages/message-types/queries) | Yes | Yes | Yes | Yes | Yes | Supports schemas, operations, and producer/consumer relationships |
|
|
17
|
+
| [Channel](/docs/development/guides/resources/messages/message-channels/introduction) | Yes | Yes | Yes | Yes | Yes | Supports common metadata |
|
|
18
|
+
| [Entity](/docs/development/guides/resources/entities/introduction) | Yes | Yes | Yes | Yes | Yes | Supports common metadata |
|
|
19
|
+
| [Data store](/docs/development/guides/resources/data/introduction) | Yes | Yes | Yes | Yes | Yes | Represented as EventCatalog container resources |
|
|
20
|
+
| [Flow](/docs/development/guides/resources/flows/introduction) | Yes | Yes | Yes | Yes | Yes | Supports flow step editing |
|
|
21
|
+
| [User](/docs/development/guides/owners/what-are-teams-and-users) | Yes | Yes | Yes | Yes | Yes | Versionless |
|
|
22
|
+
| [Team](/docs/development/guides/owners/what-are-teams-and-users) | Yes | Yes | Yes | Yes | Yes | Versionless |
|
|
23
23
|
|
|
24
24
|
## Schemas
|
|
25
25
|
|
|
26
26
|
Schemas are supported on:
|
|
27
27
|
|
|
28
|
-
- [Events](/docs/development/guides/messages/events
|
|
29
|
-
- [Commands](/docs/development/guides/messages/commands
|
|
30
|
-
- [Queries](/docs/development/guides/messages/queries
|
|
28
|
+
- [Events](/docs/development/guides/resources/messages/message-types/events)
|
|
29
|
+
- [Commands](/docs/development/guides/resources/messages/message-types/commands)
|
|
30
|
+
- [Queries](/docs/development/guides/resources/messages/message-types/queries)
|
|
31
31
|
|
|
32
32
|
## Specifications
|
|
33
33
|
|
|
34
34
|
Specifications are supported on:
|
|
35
35
|
|
|
36
36
|
- [Domains](/docs/development/guides/domains/introduction)
|
|
37
|
-
- [Services](/docs/development/guides/services/introduction)
|
|
37
|
+
- [Services](/docs/development/guides/resources/services/introduction)
|
|
38
38
|
|
|
39
39
|
Supported specification types:
|
|
40
40
|
|
|
@@ -46,11 +46,11 @@ This will map your routes into commands, events and queries in your catalog and
|
|
|
46
46
|
|
|
47
47
|
## Commercial and License
|
|
48
48
|
|
|
49
|
-
This plugin requires
|
|
49
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
50
50
|
|
|
51
|
-
You can get a
|
|
51
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
52
52
|
|
|
53
|
-
After the trial you can
|
|
53
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
54
54
|
|
|
55
55
|
See [pricing](/pricing) for more information.
|
|
56
56
|
|
|
@@ -59,16 +59,16 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
|
59
59
|
## License FAQ
|
|
60
60
|
|
|
61
61
|
### What is the license key for?
|
|
62
|
-
The license key is required to use the Amazon API Gateway plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
62
|
+
The EventCatalog Scale license key is required to use the Amazon API Gateway plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
63
63
|
|
|
64
|
-
### How do I get
|
|
65
|
-
You can obtain
|
|
64
|
+
### How do I get an EventCatalog Scale license key?
|
|
65
|
+
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). Your organization can start with a 30-day trial.
|
|
66
66
|
|
|
67
67
|
### Terms
|
|
68
|
-
- **Trial Period**:
|
|
68
|
+
- **Trial Period**: 30-day free trial no credit card required
|
|
69
69
|
- **Support**: Discord community support (extra for priority support)
|
|
70
70
|
|
|
71
|
-
After your trial period ends, you can
|
|
71
|
+
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
72
72
|
|
|
73
73
|
## Issues
|
|
74
74
|
|