@eventcatalog/core 4.1.3 → 4.1.5
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-DDGOJV25.js → chunk-DIUAURE2.js} +1 -1
- package/dist/{chunk-WEDJTUSQ.js → chunk-E6IUV4GX.js} +1 -1
- package/dist/{chunk-TUKKXNQR.js → chunk-G74MXXTG.js} +1 -1
- package/dist/{chunk-PDQER3NQ.js → chunk-GIU3S4CI.js} +1 -1
- package/dist/{chunk-G3D7IZ67.js → chunk-X77TET65.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/public/android-chrome-192x192.png +0 -0
- package/eventcatalog/public/android-chrome-512x512.png +0 -0
- package/eventcatalog/public/apple-touch-icon.png +0 -0
- package/eventcatalog/public/favicon-16x16.png +0 -0
- package/eventcatalog/public/favicon-32x32.png +0 -0
- package/eventcatalog/public/favicon-48x48.png +0 -0
- package/eventcatalog/public/favicon-96x96.png +0 -0
- package/eventcatalog/public/favicon.ico +0 -0
- package/eventcatalog/public/favicon.svg +8 -0
- package/eventcatalog/src/components/Seo.astro +5 -1
- package/eventcatalog/src/enterprise/auth/error.astro +3 -1
- package/eventcatalog/src/enterprise/auth/login.astro +3 -1
- package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +4 -1
- package/eventcatalog/src/pages/studio.astro +3 -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
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 3
|
|
3
|
+
sidebar_label: Create a service
|
|
4
|
+
title: Create a service
|
|
5
|
+
description: Add the first service to your tutorial catalog.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import ChapterOverview from '@site/src/components/MDX/ChapterOverview';
|
|
9
|
+
|
|
10
|
+
In this step, you will add your first service to the catalog.
|
|
11
|
+
|
|
12
|
+
A service is a system, application, or process that owns part of your architecture. Later in the tutorial, this service will send and receive events. For now, you only need a simple service page that gives people a place to start.
|
|
13
|
+
|
|
14
|
+
<ChapterOverview
|
|
15
|
+
items={[
|
|
16
|
+
{
|
|
17
|
+
icon: 'folder',
|
|
18
|
+
text: 'Create the folder structure for OrderService.',
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
icon: 'file',
|
|
22
|
+
text: 'Add an index.mdx file with the service metadata.',
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
icon: 'eye',
|
|
26
|
+
text: 'Refresh EventCatalog and find the service in the browser.',
|
|
27
|
+
},
|
|
28
|
+
]}
|
|
29
|
+
/>
|
|
30
|
+
|
|
31
|
+
### Create the service folder
|
|
32
|
+
|
|
33
|
+
From the root of your catalog, create a new folder for the service:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
mkdir -p services/OrderService
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
EventCatalog looks inside the `services` folder for service pages. Each service has its own folder and an `index.mdx` file.
|
|
40
|
+
|
|
41
|
+
### Add the service page
|
|
42
|
+
|
|
43
|
+
Create a new file at `services/OrderService/index.mdx`:
|
|
44
|
+
|
|
45
|
+
```mdx title="services/OrderService/index.mdx"
|
|
46
|
+
---
|
|
47
|
+
id: OrderService
|
|
48
|
+
name: Order Service
|
|
49
|
+
version: 0.0.1
|
|
50
|
+
summary: |
|
|
51
|
+
Handles customer orders from checkout through to fulfilment.
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Overview
|
|
55
|
+
|
|
56
|
+
The Order Service is responsible for creating and managing customer orders.
|
|
57
|
+
|
|
58
|
+
In this tutorial, you will use this service to learn how EventCatalog connects services, domains, events, schemas, and ownership.
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Keep the content small for now. The important part is the frontmatter at the top of the file:
|
|
62
|
+
|
|
63
|
+
- `id` is the stable identifier EventCatalog uses for links and references.
|
|
64
|
+
- `name` is the label people see in the UI.
|
|
65
|
+
- `version` is the version of this service.
|
|
66
|
+
- `summary` appears in service lists and page headers.
|
|
67
|
+
|
|
68
|
+
### Check the service in EventCatalog
|
|
69
|
+
|
|
70
|
+
If your catalog is still running, refresh your browser.
|
|
71
|
+
|
|
72
|
+
If it is not running, start it again:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npm run dev
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Open the local EventCatalog URL shown in your terminal. You should now see the Order Service in your catalog at [http://localhost:3000/docs/services/OrderService/0.0.1](http://localhost:3000/docs/services/OrderService/0.0.1).
|
|
79
|
+
|
|
80
|
+
<figure style={{ textAlign: "center" }}>
|
|
81
|
+
<img
|
|
82
|
+
src="/img/tutorial/order-service-page.png"
|
|
83
|
+
alt="The Order Service page in EventCatalog"
|
|
84
|
+
style={{ display: "block", margin: "0 auto" }}
|
|
85
|
+
/>
|
|
86
|
+
<figcaption style={{ fontSize: "0.875rem", fontStyle: "italic" }}>The Order Service page after adding the service file.</figcaption>
|
|
87
|
+
</figure>
|
|
88
|
+
|
|
89
|
+
### What you have now
|
|
90
|
+
|
|
91
|
+
Your catalog now has one documented service:
|
|
92
|
+
|
|
93
|
+
- `services/OrderService/index.mdx`
|
|
94
|
+
|
|
95
|
+
This is the first building block. Next, you will group your architecture around a domain.
|
|
96
|
+
|
|
97
|
+
### Next
|
|
98
|
+
|
|
99
|
+
Continue to [Create an event](/docs/tutorial/create-event).
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 9
|
|
3
|
+
sidebar_label: Visualize your catalog
|
|
4
|
+
title: Visualize your catalog
|
|
5
|
+
description: Use EventCatalog visualizations to inspect the tutorial architecture.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import ChapterOverview from '@site/src/components/MDX/ChapterOverview';
|
|
9
|
+
|
|
10
|
+
In this step, you will use EventCatalog visualizations to understand the model you created.
|
|
11
|
+
|
|
12
|
+
Visualizations help people see how systems connect. They grow as your catalog grows, so the same view can start with one event relationship and later include domains, commands, queries, flows, channels, data stores, agents, and other architecture primitives.
|
|
13
|
+
|
|
14
|
+
<ChapterOverview
|
|
15
|
+
items={[
|
|
16
|
+
{
|
|
17
|
+
icon: 'network',
|
|
18
|
+
text: 'Use NodeGraph inside documentation pages.',
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
icon: 'eye',
|
|
22
|
+
text: 'Use the Visualizer to explore the catalog map.',
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
icon: 'code',
|
|
26
|
+
text: 'Export visualizations to Mermaid when you need to share or edit them elsewhere.',
|
|
27
|
+
},
|
|
28
|
+
]}
|
|
29
|
+
/>
|
|
30
|
+
|
|
31
|
+
### Use NodeGraph on a page
|
|
32
|
+
|
|
33
|
+
The [`NodeGraph`](/docs/development/components/components/nodegraph) component can be added to domain, service, message, changelog, and custom documentation pages.
|
|
34
|
+
|
|
35
|
+
Add it to a resource page like this:
|
|
36
|
+
|
|
37
|
+
```mdx
|
|
38
|
+
<NodeGraph />
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
When used without props, `NodeGraph` renders a visualization for the current page. For example, on the `OrderPlaced` page it can show the event, the service that publishes it, and the service that consumes it.
|
|
42
|
+
|
|
43
|
+
You can also render a graph for a specific resource:
|
|
44
|
+
|
|
45
|
+
```mdx
|
|
46
|
+
<NodeGraph id="E-Commerce" version="0.0.1" type="domain" />
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
This is useful when you want the visualization to appear directly next to the documentation people are reading.
|
|
50
|
+
|
|
51
|
+
### Use the Visualizer
|
|
52
|
+
|
|
53
|
+
The Visualizer is the full map view in EventCatalog. It gives you more room to explore how resources connect across your catalog.
|
|
54
|
+
|
|
55
|
+
Open the `OrderPlaced` map from the event page. You should see:
|
|
56
|
+
|
|
57
|
+
- `OrderService` publishes `OrderPlaced`.
|
|
58
|
+
- `InventoryService` consumes `OrderPlaced`.
|
|
59
|
+
- the relationship between the producer, event, and consumer.
|
|
60
|
+
|
|
61
|
+
<figure style={{ textAlign: "center" }}>
|
|
62
|
+
<img
|
|
63
|
+
src="/img/tutorial/order-placed-producer-consumer-map.png"
|
|
64
|
+
alt="The OrderPlaced visualizer map showing OrderService as producer and InventoryService as consumer"
|
|
65
|
+
style={{ display: "block", margin: "0 auto" }}
|
|
66
|
+
/>
|
|
67
|
+
<figcaption style={{ fontSize: "0.875rem", fontStyle: "italic" }}>
|
|
68
|
+
The OrderPlaced map shows the producer, event, and consumer relationship.
|
|
69
|
+
</figcaption>
|
|
70
|
+
</figure>
|
|
71
|
+
|
|
72
|
+
Now open the `E-Commerce` domain map. The domain only references the services, but the map can still show the event relationship between them.
|
|
73
|
+
|
|
74
|
+
<figure style={{ textAlign: "center" }}>
|
|
75
|
+
<img
|
|
76
|
+
src="/img/tutorial/e-commerce-domain-map.png"
|
|
77
|
+
alt="The E-Commerce domain visualizer map showing services and their event relationship"
|
|
78
|
+
style={{ display: "block", margin: "0 auto" }}
|
|
79
|
+
/>
|
|
80
|
+
<figcaption style={{ fontSize: "0.875rem", fontStyle: "italic" }}>
|
|
81
|
+
The E-Commerce domain map gives a focused view of the services in that part of the architecture.
|
|
82
|
+
</figcaption>
|
|
83
|
+
</figure>
|
|
84
|
+
|
|
85
|
+
### Export to Mermaid
|
|
86
|
+
|
|
87
|
+
NodeGraph visualizations can be switched to Mermaid view or copied as Mermaid diagram code. This is useful when you want to share the architecture with another tool, paste it into documentation, or give it to an AI assistant for review.
|
|
88
|
+
|
|
89
|
+
You can learn more in the [NodeGraph docs](/docs/development/components/components/nodegraph#export-as-mermaid) and the [Mermaid docs](/docs/development/components/diagram-syntax/mermaid#export-nodegraphs-as-mermaid).
|
|
90
|
+
|
|
91
|
+
### What you have now
|
|
92
|
+
|
|
93
|
+
You can use EventCatalog to:
|
|
94
|
+
|
|
95
|
+
- embed visualizations directly inside documentation pages
|
|
96
|
+
- explore the wider catalog with the Visualizer
|
|
97
|
+
- see events between systems
|
|
98
|
+
- understand how services, domains, ownership, and messages connect
|
|
99
|
+
- export visualizations as Mermaid when you need to use them elsewhere
|
|
100
|
+
|
|
101
|
+
As you add more resources, these visualizations become more useful. Commands, queries, domains, flows, channels, data stores, agents, and extra services can all add more context to the map.
|
|
102
|
+
|
|
103
|
+
### Next
|
|
104
|
+
|
|
105
|
+
Continue to [Build and deploy your catalog](/docs/tutorial/build-your-catalog).
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 10
|
|
3
|
+
sidebar_label: Build and deploy
|
|
4
|
+
title: Build and deploy your catalog
|
|
5
|
+
description: Build your EventCatalog site and choose a deployment path.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import ChapterOverview from '@site/src/components/MDX/ChapterOverview';
|
|
9
|
+
|
|
10
|
+
In this step, you will build your catalog and decide how you want to deploy it.
|
|
11
|
+
|
|
12
|
+
Most new EventCatalog projects build as a static site. That means EventCatalog creates HTML files that you can host on most static hosting platforms.
|
|
13
|
+
|
|
14
|
+
<ChapterOverview
|
|
15
|
+
items={[
|
|
16
|
+
{
|
|
17
|
+
icon: 'code',
|
|
18
|
+
text: 'Run a production build.',
|
|
19
|
+
},
|
|
20
|
+
{
|
|
21
|
+
icon: 'eye',
|
|
22
|
+
text: 'Preview the built catalog locally.',
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
icon: 'server',
|
|
26
|
+
text: 'Choose a deployment path for your team.',
|
|
27
|
+
},
|
|
28
|
+
]}
|
|
29
|
+
/>
|
|
30
|
+
|
|
31
|
+
### Build the catalog
|
|
32
|
+
|
|
33
|
+
Run:
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
npm run build
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
EventCatalog creates a production-ready build in the `dist` folder.
|
|
40
|
+
|
|
41
|
+
You can learn more in the [develop and build guide](/docs/development/getting-started/develop-and-build) and the [static build guide](/docs/development/deployment/build-and-deploy).
|
|
42
|
+
|
|
43
|
+
### Preview the build
|
|
44
|
+
|
|
45
|
+
After the build finishes, preview the built catalog locally:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npm run preview
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
This lets you check the production build before you publish it.
|
|
52
|
+
|
|
53
|
+
If the build fails, check the error in your terminal first. Common issues are broken links, invalid frontmatter, schema path mistakes, or missing files.
|
|
54
|
+
|
|
55
|
+
### Choose a deployment path
|
|
56
|
+
|
|
57
|
+
For most first catalogs, static hosting is the simplest path. You can deploy the `dist` folder to the hosting platform your team already uses.
|
|
58
|
+
|
|
59
|
+
EventCatalog also supports server-side rendering for larger catalogs or features that need a server.
|
|
60
|
+
|
|
61
|
+
Useful deployment docs:
|
|
62
|
+
|
|
63
|
+
- [Build and deploy](/docs/development/deployment/build-and-deploy)
|
|
64
|
+
- [Hosting options](/docs/development/deployment/hosting-options)
|
|
65
|
+
- [Deployment workflows](/docs/development/deployment/deployment-workflows)
|
|
66
|
+
- [SSR mode](/docs/development/deployment/build-ssr-mode)
|
|
67
|
+
|
|
68
|
+
### What you have now
|
|
69
|
+
|
|
70
|
+
You now know how to:
|
|
71
|
+
|
|
72
|
+
- build the catalog for production
|
|
73
|
+
- preview the production build locally
|
|
74
|
+
- choose between static hosting and server-side rendering
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Next
|
|
78
|
+
|
|
79
|
+
Continue to [Next steps](/docs/tutorial/next-steps).
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
---
|
|
2
|
+
sidebar_position: 11
|
|
3
|
+
sidebar_label: Next steps
|
|
4
|
+
title: Next steps
|
|
5
|
+
description: Grow your catalog beyond the tutorial.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
import ChapterOverview from '@site/src/components/MDX/ChapterOverview';
|
|
9
|
+
|
|
10
|
+
Congratulations, you have created your first EventCatalog.
|
|
11
|
+
|
|
12
|
+
This is a real catalog now. It models architecture primitives, links them together, and gives people a place to understand how part of your system works.
|
|
13
|
+
|
|
14
|
+
<ChapterOverview
|
|
15
|
+
title="Your catalog now has..."
|
|
16
|
+
description="The first pieces of a useful architecture catalog"
|
|
17
|
+
items={[
|
|
18
|
+
{
|
|
19
|
+
icon: 'server',
|
|
20
|
+
text: 'Services that describe the systems in your architecture.',
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
icon: 'network',
|
|
24
|
+
text: 'An event with producer and consumer relationships.',
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
icon: 'code',
|
|
28
|
+
text: 'A schema that explains the event payload.',
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
icon: 'folder',
|
|
32
|
+
text: 'Ownership and a domain to group the work.',
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
icon: 'eye',
|
|
36
|
+
text: 'Visualizations and a production build path.',
|
|
37
|
+
},
|
|
38
|
+
]}
|
|
39
|
+
/>
|
|
40
|
+
|
|
41
|
+
This is enough to give people a useful first view of your architecture. From here, you can keep adding detail in the way that fits your team.
|
|
42
|
+
|
|
43
|
+
### See a fuller catalog
|
|
44
|
+
|
|
45
|
+
The tutorial catalog is small on purpose. EventCatalog can model many more architecture primitives, including [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), [data stores](/docs/development/guides/resources/data/introduction), [data products](/docs/development/guides/resources/data-products/introduction), [agents](/docs/development/guides/resources/agents/introduction), [owners](/docs/development/guides/owners/what-are-teams-and-users), [domains](/docs/development/guides/domains/introduction), [flows](/docs/development/guides/resources/flows/introduction), and the relationships between them.
|
|
46
|
+
|
|
47
|
+
You can explore the public [EventCatalog demo catalog](https://demo.eventcatalog.dev/) to see a larger example.
|
|
48
|
+
|
|
49
|
+
<figure style={{ textAlign: "center" }}>
|
|
50
|
+
<img
|
|
51
|
+
src="/img/tutorial/demo-catalog-orders-service-visualizer.png"
|
|
52
|
+
alt="The EventCatalog demo visualizer showing a larger Orders Service architecture"
|
|
53
|
+
style={{ display: "block", margin: "0 auto" }}
|
|
54
|
+
/>
|
|
55
|
+
<figcaption style={{ fontSize: "0.875rem", fontStyle: "italic" }}>
|
|
56
|
+
The demo catalog visualizer shows services, events, channels, data stores, agents, and workflows connected together.
|
|
57
|
+
</figcaption>
|
|
58
|
+
</figure>
|
|
59
|
+
|
|
60
|
+
[Open this view in the demo catalog](https://demo.eventcatalog.dev/visualiser/services/OrdersService/0.0.3).
|
|
61
|
+
|
|
62
|
+
### Add more documentation
|
|
63
|
+
|
|
64
|
+
Every resource page is Markdown and MDX. You can add more explanation, diagrams, links, runbooks, examples, or any other content that helps people understand the system.
|
|
65
|
+
|
|
66
|
+
Useful docs:
|
|
67
|
+
|
|
68
|
+
- [Using components](/docs/development/components/using-components)
|
|
69
|
+
- [Custom components](/docs/development/components/custom-components/introduction)
|
|
70
|
+
- [Resource references](/docs/development/components/resource-references)
|
|
71
|
+
- [Bring your own documentation](/docs/development/bring-your-own-documentation/custom-pages/adding-custom-docs)
|
|
72
|
+
|
|
73
|
+
### Edit visually with EventCatalog Editor
|
|
74
|
+
|
|
75
|
+
If you prefer a visual local editor, try [EventCatalog Editor](/docs/editor/overview). It runs locally and gives you a UI for editing the catalog files in your project.
|
|
76
|
+
|
|
77
|
+
### Automate from existing specifications
|
|
78
|
+
|
|
79
|
+
You do not have to maintain everything by hand. EventCatalog can generate catalog resources from specifications and registries.
|
|
80
|
+
|
|
81
|
+
Useful plugin docs:
|
|
82
|
+
|
|
83
|
+
- [OpenAPI plugin](/docs/plugins/openapi/intro)
|
|
84
|
+
- [AsyncAPI plugin](/docs/plugins/asyncapi/intro)
|
|
85
|
+
- [Confluent Schema Registry plugin](/docs/plugins/confluent-schema-registry/intro)
|
|
86
|
+
- [GitHub plugin](/docs/plugins/github/intro)
|
|
87
|
+
|
|
88
|
+
### Model more architecture primitives
|
|
89
|
+
|
|
90
|
+
The tutorial focused on services, events, schemas, owners, and domains. EventCatalog can model more of your architecture as your catalog grows.
|
|
91
|
+
|
|
92
|
+
Use these docs when you are ready to add more primitives to your catalog:
|
|
93
|
+
|
|
94
|
+
- [Domains](/docs/development/guides/domains/introduction)
|
|
95
|
+
- [Services](/docs/development/guides/resources/services/introduction)
|
|
96
|
+
- [Events](/docs/development/guides/resources/messages/message-types/events)
|
|
97
|
+
- [Commands](/docs/development/guides/resources/messages/message-types/commands)
|
|
98
|
+
- [Queries](/docs/development/guides/resources/messages/message-types/queries)
|
|
99
|
+
- [Channels](/docs/development/guides/resources/messages/message-channels/introduction)
|
|
100
|
+
- [Data stores](/docs/development/guides/resources/data/introduction)
|
|
101
|
+
- [Data products](/docs/development/guides/resources/data-products/introduction)
|
|
102
|
+
- [Agents](/docs/development/guides/resources/agents/introduction)
|
|
103
|
+
- [Flows](/docs/development/guides/resources/flows/add-flows-to-resources)
|
|
104
|
+
- [Owners](/docs/development/guides/owners/what-are-teams-and-users)
|
|
105
|
+
|
|
106
|
+
### Keep improving the catalog
|
|
107
|
+
|
|
108
|
+
Start small, keep the content close to the systems it describes, and add more detail when people ask questions the catalog cannot answer yet.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"label": "Tutorial",
|
|
3
|
+
"position": 1,
|
|
4
|
+
"collapsible": false,
|
|
5
|
+
"collapsed": false,
|
|
6
|
+
"link": {
|
|
7
|
+
"type": "generated-index",
|
|
8
|
+
"slug": "tutorial",
|
|
9
|
+
"title": "EventCatalog Tutorial",
|
|
10
|
+
"description": "Build your first EventCatalog from a small commerce architecture and learn how domains, services, messages, schemas, owners, and visualizations fit together."
|
|
11
|
+
}
|
|
12
|
+
}
|
package/dist/eventcatalog.cjs
CHANGED
|
@@ -144,7 +144,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
|
|
|
144
144
|
var import_picocolors = __toESM(require("picocolors"), 1);
|
|
145
145
|
|
|
146
146
|
// package.json
|
|
147
|
-
var version = "4.1.
|
|
147
|
+
var version = "4.1.5";
|
|
148
148
|
|
|
149
149
|
// src/constants.ts
|
|
150
150
|
var VERSION = version;
|
package/dist/eventcatalog.js
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "./chunk-
|
|
3
|
+
} from "./chunk-DIUAURE2.js";
|
|
4
4
|
import {
|
|
5
5
|
runMigrations
|
|
6
6
|
} from "./chunk-XUAF2H54.js";
|
|
7
7
|
import "./chunk-CA4U2JP7.js";
|
|
8
8
|
import {
|
|
9
9
|
generate
|
|
10
|
-
} from "./chunk-
|
|
10
|
+
} from "./chunk-E6IUV4GX.js";
|
|
11
11
|
import {
|
|
12
12
|
logger
|
|
13
|
-
} from "./chunk-
|
|
13
|
+
} from "./chunk-G74MXXTG.js";
|
|
14
14
|
import {
|
|
15
15
|
resolve_catalog_dependencies_default
|
|
16
16
|
} from "./chunk-LHR4G2UO.js";
|
|
@@ -20,7 +20,7 @@ import {
|
|
|
20
20
|
import {
|
|
21
21
|
watch
|
|
22
22
|
} from "./chunk-CAJUIMDJ.js";
|
|
23
|
-
import "./chunk-
|
|
23
|
+
import "./chunk-GIU3S4CI.js";
|
|
24
24
|
import "./chunk-K2XIENVT.js";
|
|
25
25
|
import {
|
|
26
26
|
catalogToAstro
|
|
@@ -28,7 +28,7 @@ import {
|
|
|
28
28
|
import "./chunk-W5JQON7Z.js";
|
|
29
29
|
import {
|
|
30
30
|
VERSION
|
|
31
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-X77TET65.js";
|
|
32
32
|
import {
|
|
33
33
|
linkCoreNodeModules,
|
|
34
34
|
resolveInstalledCoreNodeModules
|
package/dist/generate.cjs
CHANGED
|
@@ -108,7 +108,7 @@ var getEventCatalogConfigFile = async (projectDirectory) => {
|
|
|
108
108
|
var import_picocolors = __toESM(require("picocolors"), 1);
|
|
109
109
|
|
|
110
110
|
// package.json
|
|
111
|
-
var version = "4.1.
|
|
111
|
+
var version = "4.1.5";
|
|
112
112
|
|
|
113
113
|
// src/constants.ts
|
|
114
114
|
var VERSION = version;
|
package/dist/generate.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
generate
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
5
|
-
import "./chunk-
|
|
3
|
+
} from "./chunk-E6IUV4GX.js";
|
|
4
|
+
import "./chunk-G74MXXTG.js";
|
|
5
|
+
import "./chunk-X77TET65.js";
|
|
6
6
|
import "./chunk-6QENHZZP.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
package/dist/utils/cli-logger.js
CHANGED
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="58 54 1133 1133" role="img" aria-labelledby="t">
|
|
2
|
+
<title id="t">Reading cat logo</title>
|
|
3
|
+
<style>
|
|
4
|
+
path { fill: #000; }
|
|
5
|
+
@media (prefers-color-scheme: dark) { path { fill: #fff; } }
|
|
6
|
+
</style>
|
|
7
|
+
<path fill-rule="evenodd" d="M 445 55 c -174.6 0.5 -188.1 0.7 -196.5 2.3 -20.7 4.1 -35.3 8.5 -51 15.3 -66.7 28.8 -114.7 86.9 -130.3 157.9 l -2.6 12 -0.4 371 c -0.2 261 0 373.8 0.8 380.5 4.6 40.7 21.8 79.6 49.8 113 36.8 43.9 89.5 72.4 144.2 77.9 5.9 0.6 148.2 1.1 372.5 1.3 345.2 0.3 363.5 0.2 373 -1.5 32.1 -5.7 58.7 -16.4 85.5 -34.2 53.2 -35.3 89.1 -93.6 96 -156 0.8 -7.2 1 -114.8 0.8 -381.5 l -0.3 -371.5 -2.2 -10.4 c -7.7 -35.9 -18.8 -61.1 -38.9 -88.2 -9.5 -12.8 -30.7 -34.1 -43.4 -43.5 -34.4 -25.6 -73.7 -40.9 -113.5 -44.3 -12.5 -1.1 -182.7 -1.1 -543.5 -0.1 z m -26.3 152.5 c 30.7 11.6 86.7 67 122.9 121.6 l 8.4 12.6 9.7 -2.3 c 13.3 -3.3 30.3 -6.1 44.8 -7.5 15.1 -1.5 51.8 -0.6 67.5 1.6 10.1 1.4 37.1 6.8 40.5 8.1 0.7 0.3 3.6 -3.4 7.1 -8.8 18.3 -29.1 37.9 -53.5 64.7 -80.7 31.8 -32.2 53.3 -47 68.5 -47.1 10.5 -0 16.2 4.1 22.3 16.1 11.6 23 17.3 80.8 15 153.1 l -1 33.7 6 14.7 c 3.2 8 7.8 20.4 10 27.5 2.3 7.1 4.5 12.9 4.9 12.9 0.4 -0 5 -1.5 10.1 -3.4 29.8 -10.8 61.4 -20.5 89.6 -27.5 20 -5.1 21.5 -5.1 25.9 -0.7 2.9 2.9 3.4 4.1 3.4 7.9 0 3.4 -0.6 5.3 -2.5 7.5 -2.9 3.5 -4.7 4.3 -18 7.7 -23.9 6.3 -83.7 25.2 -103 32.5 -2 0.8 -2 1.2 -1 10.6 0.5 5.3 1.5 9.9 2 10 0.6 0.2 16.8 2.4 36 4.9 69.6 9.1 85.9 11.5 89.4 13.3 10.1 5.1 7.6 20.4 -3.6 21.9 -3.7 0.5 -26.4 -2.1 -63.3 -7.2 -18.4 -2.6 -56.7 -7.5 -58 -7.5 -0.4 -0 -1 0.8 -1.2 1.8 -0.4 1.4 -2.9 2.3 -11.4 4.1 -50.2 10.3 -130.1 33.1 -167.9 47.8 -35.1 13.6 -69.4 33.4 -96.1 55.6 -6.6 5.4 -10.1 7.7 -10.9 7.1 -0.7 -0.5 -5.8 -4.6 -11.5 -9.2 -25 -20.2 -55.1 -37.5 -88.5 -50.7 -39.3 -15.6 -111.9 -36.5 -170.7 -49.1 -15.1 -3.2 -17.8 -4.1 -17.8 -5.6 0 -2.4 0.4 -2.4 -35 2.2 -16.8 2.2 -42.6 5.7 -57.5 7.6 -14.8 2 -28.8 3.3 -31 3 -5.9 -0.7 -9.5 -5.1 -9.5 -11.5 0 -5.7 2.4 -9.4 7.3 -11 3.2 -1.1 62.2 -9.4 103.2 -14.6 11.6 -1.5 21.3 -3 21.7 -3.3 0.3 -0.4 0.9 -5 1.3 -10.3 l 0.7 -9.6 -30.3 -10.1 c -24.9 -8.3 -73.2 -22.8 -85.2 -25.6 -1.5 -0.4 -4.1 -1.9 -5.8 -3.4 -2.6 -2.3 -3.3 -3.8 -3.7 -8 -0.4 -4.7 -0.2 -5.4 2.5 -8.1 1.7 -1.6 4.3 -3.3 5.8 -3.7 5.8 -1.4 46 9.3 88.5 23.7 16.2 5.5 30.3 10.3 31.2 10.6 1 0.3 2 -0.1 2.2 -0.8 4.6 -14.9 9 -27.2 14 -39.4 l 6.2 -15 -1 -32.5 c -1.5 -48.5 0.9 -93.8 6.4 -122.4 5 -25.8 12 -40.4 21.9 -45.6 5.4 -2.9 15.3 -2.6 23.8 0.5 z m -67.6 364.4 c 81.9 16.7 161.5 40.4 199.3 59.3 11.7 5.9 29.8 16.7 34.1 20.3 l 3 2.6 -9.5 -0.4 c -8.7 -0.4 -15.5 -2.1 -78.5 -19.7 -37.9 -10.6 -76 -21.2 -84.5 -23.5 -56.6 -15.7 -123.4 -34.6 -123.8 -35 -0.6 -0.6 13.5 -2.8 37.3 -5.8 6.4 -0.8 8.6 -0.6 22.6 2.2 z m 589.5 -0.4 c 10.4 1.4 20.4 2.8 22.3 3.2 3.4 0.6 -40.5 13.5 -170.9 50.2 -20.1 5.7 -42.6 12 -50 14.1 -50.1 14.2 -53.5 15 -60.8 15 -4 -0 -7.2 -0.3 -7.2 -0.8 0 -2.1 28.9 -19.2 45.8 -27.1 36.1 -16.7 110.6 -38.3 193.2 -55.9 6.6 -1.4 7.1 -1.4 27.6 1.3 z m -672.2 33.1 c 13.2 3.6 31.1 8.5 39.6 10.9 8.5 2.4 35.3 9.8 59.5 16.4 52.5 14.3 120.5 33 167.5 46.1 22.9 6.3 23.5 6.6 24.9 9.6 0.8 1.8 1.1 45.6 1.1 162.2 0 175.7 0.4 164.2 -5.9 164.2 -1.5 -0 -12.4 -2.7 -24.2 -6.1 -20.6 -5.8 -66.3 -18.6 -188.9 -52.7 -31.6 -8.8 -63.1 -17.5 -70 -19.2 -13 -3.3 -16.3 -4.8 -17.9 -7.8 -1.1 -2.1 -7.2 -104.7 -15.6 -262.7 -1.3 -25.9 -2.7 -50.5 -3.1 -54.7 -0.6 -7.3 -0.5 -7.8 2 -10.2 1.4 -1.5 3.5 -2.6 4.7 -2.6 1.2 -0 13 3 26.3 6.6 z m 748.1 -5.6 c 3.9 1.5 4.4 4.2 3.4 19.5 -0.8 12.4 -4.2 70.9 -15 256 -2.6 46 -3.3 53.3 -4.8 55.5 -1.9 2.6 1.3 1.6 -78.6 23.9 -9.9 2.8 -34.2 9.6 -54 15.1 -19.8 5.6 -50.4 14.1 -68 19 -17.6 4.9 -45.7 12.8 -62.5 17.5 -16.7 4.7 -31.7 8.5 -33.2 8.5 -6.3 -0 -5.9 11.3 -5.6 -165.1 0.2 -88.2 0.7 -161.2 1.2 -162.1 0.9 -1.9 4.6 -3.1 32.6 -10.7 10.2 -2.8 25.9 -7.1 35 -9.6 9.1 -2.5 32 -8.9 51 -14.1 47.4 -13.1 124.2 -34.5 168.5 -46.9 14.3 -4 26.3 -7.4 26.7 -7.4 0.4 -0.1 1.8 0.3 3.3 0.9 z m -351.7 95.3 c 0.9 0.7 1.2 35.1 1.2 166.7 l 0 165.9 -2.2 1.3 c -1.8 1 -10.2 1.3 -35.1 1.3 -31.4 -0 -32.9 -0.1 -34.3 -1.9 -2.1 -2.9 -2.1 -330.7 0 -332.8 1.1 -1.2 7.6 -1.4 35.2 -1.4 18.7 0.1 34.5 0.5 35.2 0.9 z"/>
|
|
8
|
+
</svg>
|
|
@@ -25,7 +25,11 @@ if (typeof _image === 'string') {
|
|
|
25
25
|
<meta charset="UTF-8" />
|
|
26
26
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
27
27
|
<meta name="viewport" content="width=device-width" />
|
|
28
|
-
<link rel="icon"
|
|
28
|
+
<link rel="icon" href={buildUrl('/favicon.ico', true)} sizes="any" />
|
|
29
|
+
<link rel="icon" type="image/svg+xml" href={buildUrl('/favicon.svg', true)} />
|
|
30
|
+
<link rel="icon" type="image/png" sizes="32x32" href={buildUrl('/favicon-32x32.png', true)} />
|
|
31
|
+
<link rel="icon" type="image/png" sizes="16x16" href={buildUrl('/favicon-16x16.png', true)} />
|
|
32
|
+
<link rel="apple-touch-icon" href={buildUrl('/apple-touch-icon.png', true)} />
|
|
29
33
|
|
|
30
34
|
<SEO
|
|
31
35
|
title={title}
|
|
@@ -21,7 +21,9 @@ const errorMessage = errorMessages[error] || errorMessages.Default;
|
|
|
21
21
|
<head>
|
|
22
22
|
<meta charset="UTF-8" />
|
|
23
23
|
<meta name="viewport" content="width=device-width" />
|
|
24
|
-
<link rel="icon"
|
|
24
|
+
<link rel="icon" href="/favicon.ico" sizes="any" />
|
|
25
|
+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
|
26
|
+
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
|
|
25
27
|
<meta name="generator" content={Astro.generator} />
|
|
26
28
|
<title>Authentication Error - EventCatalog</title>
|
|
27
29
|
</head>
|
|
@@ -102,7 +102,9 @@ const providerConfig = {
|
|
|
102
102
|
<head>
|
|
103
103
|
<meta charset="UTF-8" />
|
|
104
104
|
<meta name="viewport" content="width=device-width" />
|
|
105
|
-
<link rel="icon"
|
|
105
|
+
<link rel="icon" href="/favicon.ico" sizes="any" />
|
|
106
|
+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
|
107
|
+
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
|
|
106
108
|
<meta name="generator" content={Astro.generator} />
|
|
107
109
|
<title>Sign In | {title}</title>
|
|
108
110
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
@@ -5,6 +5,8 @@ interface Props {
|
|
|
5
5
|
description?: string;
|
|
6
6
|
showNestedSideBar?: boolean;
|
|
7
7
|
showHeader?: boolean;
|
|
8
|
+
/** Wrap the page content in EventCatalog's default app content container. Defaults to true. */
|
|
9
|
+
wrapContent?: boolean;
|
|
8
10
|
// When true, the main content uses a reduced horizontal padding instead of the
|
|
9
11
|
// default 5rem. Used by wide pages such as the custom landing page.
|
|
10
12
|
reducedContentPadding?: boolean;
|
|
@@ -89,6 +91,7 @@ if (isCustomStylesEnabled()) {
|
|
|
89
91
|
}
|
|
90
92
|
|
|
91
93
|
const currentPath = Astro.url.pathname;
|
|
94
|
+
const wrapContent = Astro.props.wrapContent ?? true;
|
|
92
95
|
|
|
93
96
|
const getDefaultUrl = (route: string, defaultValue: string) => {
|
|
94
97
|
if (route === 'docs/custom') {
|
|
@@ -762,7 +765,7 @@ const verticalNavAutoCollapsePaths = [buildUrl('/discover', true), buildUrl('/do
|
|
|
762
765
|
}
|
|
763
766
|
<main class="content-panel sidebar-transition w-full bg-[rgb(var(--ec-page-bg))]" id="content">
|
|
764
767
|
{
|
|
765
|
-
Astro.slots.has('sidebar-content') ? (
|
|
768
|
+
Astro.slots.has('sidebar-content') || !wrapContent ? (
|
|
766
769
|
<slot />
|
|
767
770
|
) : (
|
|
768
771
|
<div class={`app-content-wrapper ${reducedContentPadding ? 'app-content-wrapper--reduced-padding' : ''}`}>
|
|
@@ -42,7 +42,9 @@ const hasResources = resourcesToShow.length > 0;
|
|
|
42
42
|
<head>
|
|
43
43
|
<meta charset="UTF-8" />
|
|
44
44
|
<meta name="viewport" content="width=device-width" />
|
|
45
|
-
<link rel="icon"
|
|
45
|
+
<link rel="icon" href="/favicon.ico" sizes="any" />
|
|
46
|
+
<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
|
|
47
|
+
<link rel="apple-touch-icon" href="/apple-touch-icon.png" />
|
|
46
48
|
<meta name="generator" content={Astro.generator} />
|
|
47
49
|
<title>EventCatalog Studio</title>
|
|
48
50
|
</head>
|
|
@@ -20,6 +20,12 @@ import VerticalSideBarLayout from '@layouts/VerticalSideBarLayout.astro';
|
|
|
20
20
|
const { title, description, sidebar = true, showHeader = true } = Astro.props;
|
|
21
21
|
---
|
|
22
22
|
|
|
23
|
-
<VerticalSideBarLayout
|
|
23
|
+
<VerticalSideBarLayout
|
|
24
|
+
title={title}
|
|
25
|
+
description={description}
|
|
26
|
+
showHeader={showHeader}
|
|
27
|
+
showNestedSideBar={sidebar}
|
|
28
|
+
wrapContent={false}
|
|
29
|
+
>
|
|
24
30
|
<slot />
|
|
25
31
|
</VerticalSideBarLayout>
|
package/package.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
},
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE",
|
|
9
9
|
"type": "module",
|
|
10
|
-
"version": "4.1.
|
|
10
|
+
"version": "4.1.5",
|
|
11
11
|
"publishConfig": {
|
|
12
12
|
"access": "public"
|
|
13
13
|
},
|
|
@@ -117,8 +117,8 @@
|
|
|
117
117
|
"uuid": "^10.0.0",
|
|
118
118
|
"zod": "^4.3.6",
|
|
119
119
|
"@eventcatalog/linter": "1.1.4",
|
|
120
|
-
"@eventcatalog/
|
|
121
|
-
"@eventcatalog/
|
|
120
|
+
"@eventcatalog/sdk": "2.25.0",
|
|
121
|
+
"@eventcatalog/visualiser": "^4.0.1"
|
|
122
122
|
},
|
|
123
123
|
"devDependencies": {
|
|
124
124
|
"@astrojs/check": "^0.9.9",
|