@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
|
@@ -21,7 +21,7 @@ The plugin uses Azure's REST API with Bearer token authentication. You must set
|
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
# EventCatalog license key
|
|
24
|
-
export
|
|
24
|
+
export EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
25
25
|
|
|
26
26
|
# Azure Schema Registry access token
|
|
27
27
|
export AZURE_SCHEMA_REGISTRY_TOKEN=your-azure-access-token
|
|
@@ -57,8 +57,8 @@ You can assign schemas to services (producers/consumers) in your architecture.
|
|
|
57
57
|
| `services[].version` | `string` | - | Version of the service (e.g., `1.0.0`). |
|
|
58
58
|
| `services[].sends` | `array` | - | Array of schema filters for messages this service sends. |
|
|
59
59
|
| `services[].receives` | `array` | - | Array of schema filters for messages this service receives. |
|
|
60
|
-
| `services[].writesTo` | `array[{id: string, version?: string}]` | - | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service writes to. |
|
|
61
|
-
| `services[].readsFrom` | `array[{id: string, version?: string}]` | - | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service reads from. |
|
|
60
|
+
| `services[].writesTo` | `array[{id: string, version?: string}]` | - | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service writes to. |
|
|
61
|
+
| `services[].readsFrom` | `array[{id: string, version?: string}]` | - | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service reads from. |
|
|
62
62
|
|
|
63
63
|
### Schema Filters (sends/receives)
|
|
64
64
|
|
|
@@ -87,7 +87,7 @@ You can define and assign domains to organize your services.
|
|
|
87
87
|
|
|
88
88
|
| Option | Type | Default | Description |
|
|
89
89
|
|--------|------|---------|-------------|
|
|
90
|
-
| `licenseKey` | `string` | From env var | EventCatalog license key. Can also be set via `
|
|
90
|
+
| `licenseKey` | `string` | From env var | EventCatalog Scale license key. Can also be set via the `EVENTCATALOG_SCALE_LICENSE_KEY` environment variable. |
|
|
91
91
|
|
|
92
92
|
## Example Configurations
|
|
93
93
|
|
|
@@ -106,7 +106,7 @@ Each example includes:
|
|
|
106
106
|
- Azure CLI installed ([Install guide](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli))
|
|
107
107
|
- Azure account with Event Hubs namespace
|
|
108
108
|
- Azure Schema Registry with sample schemas
|
|
109
|
-
- EventCatalog license key ([
|
|
109
|
+
- EventCatalog license key ([30-day trial available](https://eventcatalog.cloud))
|
|
110
110
|
- Appropriate Azure permissions (`Azure Event Hubs Data Receiver` role)
|
|
111
111
|
|
|
112
112
|
### Quick Start
|
|
@@ -53,13 +53,13 @@ _Note: If you want to embed private EventCatalog instances, raise an issue on Gi
|
|
|
53
53
|
|
|
54
54
|
## Commercial Use
|
|
55
55
|
|
|
56
|
-
This plugin requires
|
|
56
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
57
57
|
|
|
58
|
-
You can get a
|
|
58
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
59
59
|
|
|
60
60
|
You can try the Backstage plugin, or use EventCatalog Scale (as it's already included).
|
|
61
61
|
|
|
62
|
-
After the trial you can
|
|
62
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
63
63
|
|
|
64
64
|
See [pricing](/pricing) for more information.
|
|
65
65
|
|
|
@@ -24,11 +24,11 @@ We recommend using the latest version of the plugin. You can read the [migration
|
|
|
24
24
|
|
|
25
25
|
## Configuring EventCatalog for Backstage
|
|
26
26
|
|
|
27
|
-
You will need
|
|
27
|
+
You will need an EventCatalog Scale license key to use the Backstage integration.
|
|
28
28
|
|
|
29
|
-
You can get a
|
|
29
|
+
You can get a 30-day trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
30
30
|
|
|
31
|
-
Once you have
|
|
31
|
+
Once you have an EventCatalog Scale license key, you will need to build and deploy your EventCatalog with the license key set.
|
|
32
32
|
|
|
33
33
|
#### 1. Setting license key in `.env` file (recommended)
|
|
34
34
|
|
|
@@ -37,23 +37,15 @@ Once you have a license key for Backstage, you will need to build and deploy you
|
|
|
37
37
|
Create a `.env` file in the root of your project and add the following:
|
|
38
38
|
|
|
39
39
|
```bash title=".env"
|
|
40
|
-
# If you have a Backstage license key
|
|
41
|
-
EVENTCATALOG_LICENSE_KEY_BACKSTAGE=your-license-key
|
|
42
|
-
|
|
43
|
-
# If you have a SCALE license key
|
|
44
40
|
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
45
41
|
```
|
|
46
42
|
|
|
47
|
-
:::tip Using an
|
|
48
|
-
|
|
49
|
-
If you are using an older version of EventCatalog that does not support the `.env` file, you can just export the license key as an environment variable.
|
|
43
|
+
:::tip Using an Older API Key?
|
|
50
44
|
|
|
51
|
-
|
|
52
|
-
# If you have a Backstage license key
|
|
53
|
-
export EVENTCATALOG_LICENSE_KEY_BACKSTAGE=your-license-key
|
|
45
|
+
If you already have an older Backstage plugin key, you can still use it with the Backstage-specific environment variable.
|
|
54
46
|
|
|
55
|
-
|
|
56
|
-
|
|
47
|
+
```bash title=".env"
|
|
48
|
+
EVENTCATALOG_LICENSE_KEY_BACKSTAGE=your-license-key
|
|
57
49
|
```
|
|
58
50
|
|
|
59
51
|
:::
|
|
@@ -61,11 +61,11 @@ The EventCatalog Confluent Schema Registry plugin is a generator. It will import
|
|
|
61
61
|
|
|
62
62
|
## Commercial and License
|
|
63
63
|
|
|
64
|
-
This plugin requires
|
|
64
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
65
65
|
|
|
66
|
-
You can get a
|
|
66
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
67
67
|
|
|
68
|
-
After the trial you can
|
|
68
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
69
69
|
|
|
70
70
|
See [pricing](/pricing) for more information.
|
|
71
71
|
|
|
@@ -78,13 +78,13 @@ If you would like a demo of the plugin, please feel free to reach out to us and
|
|
|
78
78
|
## License FAQ
|
|
79
79
|
|
|
80
80
|
### What is the license key for?
|
|
81
|
-
The license key is required to use the Confluent Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
81
|
+
The EventCatalog Scale license key is required to use the Confluent Schema Registry plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
82
82
|
|
|
83
|
-
### How do I get
|
|
84
|
-
You can obtain
|
|
83
|
+
### How do I get an EventCatalog Scale license key?
|
|
84
|
+
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
|
|
85
85
|
|
|
86
86
|
### Terms
|
|
87
|
-
- **Trial Period**:
|
|
87
|
+
- **Trial Period**: 30-day free trial no credit card required
|
|
88
88
|
- **Support**: Discord community support (extra for priority support)
|
|
89
89
|
|
|
90
|
-
After your trial period ends, you can
|
|
90
|
+
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
@@ -169,20 +169,30 @@ In this example we configure the plugin twice, the first time we import and crea
|
|
|
169
169
|
|
|
170
170
|
The EventCatalog Confluent Schema Registry plugin requires API keys in your environment variables.
|
|
171
171
|
|
|
172
|
-
1.
|
|
172
|
+
1. An EventCatalog Scale license key for the Confluent Schema Registry plugin (30-day trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
|
|
173
173
|
2. Confluent Schema Registry API keys (found in the [Confluent Cloud](https://confluent.cloud) console)
|
|
174
174
|
|
|
175
175
|
Create a `.env` file in the root, and add your keys to the project.
|
|
176
176
|
|
|
177
177
|
```bash title=".env"
|
|
178
178
|
# EventCatalog license key
|
|
179
|
-
|
|
179
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
180
180
|
|
|
181
181
|
# Confluent Schema Registry API Keys
|
|
182
182
|
CONFLUENT_SCHEMA_REGISTRY_KEY=your-confluent-schema-registry-key
|
|
183
183
|
CONFLUENT_SCHEMA_REGISTRY_SECRET=your-confluent-schema-registry-key-secret
|
|
184
184
|
```
|
|
185
185
|
|
|
186
|
+
:::tip Using an Older API Key?
|
|
187
|
+
|
|
188
|
+
If you already have an older Confluent Schema Registry plugin key, you can still use it with the plugin-specific environment variable.
|
|
189
|
+
|
|
190
|
+
```bash title=".env"
|
|
191
|
+
EVENTCATALOG_LICENSE_KEY_CONFLUENT_SCHEMA_REGISTRY=your-license-key
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
:::
|
|
195
|
+
|
|
186
196
|
#### White listing EventCatalog domains
|
|
187
197
|
|
|
188
198
|
If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
|
|
@@ -219,5 +229,3 @@ If you get stuck, find an issue or need help, please raise an issue on [GitHub](
|
|
|
219
229
|
|
|
220
230
|
You can also find some examples of the plugin in action in our examples repository: [eventcatalog/examples](https://github.com/event-catalog/generators/tree/main/examples/generator-confluent-schema-registry).
|
|
221
231
|
|
|
222
|
-
|
|
223
|
-
|
|
@@ -49,8 +49,8 @@ You can assign the schemas to a producer or consumer (service).
|
|
|
49
49
|
| `services.id` | string | - | EventCatalog ID for the service. |
|
|
50
50
|
| `services.sends` | Filter | - | Configuration to assign schemas to a producer. The schemas and topic defined here will be assigned to the producer. |
|
|
51
51
|
| `services.receives` | Filter | - | Configuration to assign schemas to a consumer. The schemas and topic defined here will be assigned to the consumer. |
|
|
52
|
-
| `services.writesTo` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service writes to. (Added in v0.2.1) |
|
|
53
|
-
| `services.readsFrom` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/data/introduction) id and version (optional) that the service reads from. (Added in v0.2.1) |
|
|
52
|
+
| `services.writesTo` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service writes to. (Added in v0.2.1) |
|
|
53
|
+
| `services.readsFrom` | array[\{id: string, version?: string\}] | No | Array of [data stores](/docs/development/guides/resources/data/introduction) id and version (optional) that the service reads from. (Added in v0.2.1) |
|
|
54
54
|
|
|
55
55
|
### Topics
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ Schemas are mapped to their topics.
|
|
|
60
60
|
|
|
61
61
|
| Option | Type | Default | Description |
|
|
62
62
|
|--------|------|---------|-------------|
|
|
63
|
-
| `topics` | object | - | Optional list of topics to assign the schemas to. (optional). [These are documented as channels](/docs/development/guides/channels/introduction) in EventCatalog. |
|
|
63
|
+
| `topics` | object | - | Optional list of topics to assign the schemas to. (optional). [These are documented as channels](/docs/development/guides/resources/messages/message-channels/introduction) in EventCatalog. |
|
|
64
64
|
| `topics.id` | string | - | EventCatalog ID for the topic (e.g `orders-topic`). |
|
|
65
65
|
| `topics.name` | string | - | Name of the topic (e.g `Orders Topic`). |
|
|
66
66
|
| `topics.address` | string | - | Address of the topic (e.g `kafka-cluster-1.us-east-1.confluent.cloud:9092`). |
|
|
@@ -186,37 +186,37 @@ generators: [
|
|
|
186
186
|
|
|
187
187
|
### Configure license key
|
|
188
188
|
|
|
189
|
-
The EventBridge plugin requires
|
|
189
|
+
The EventBridge plugin requires an EventCatalog Scale license key to work with EventCatalog.
|
|
190
190
|
|
|
191
|
-
You can get a
|
|
191
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
192
192
|
|
|
193
193
|
You have a few options for setting the license key:
|
|
194
194
|
|
|
195
|
-
1. [Setting license key in `.env` file (recommended)](#
|
|
196
|
-
2. [Setting license key in eventcatalog.config.js](#
|
|
195
|
+
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
196
|
+
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
197
197
|
|
|
198
|
-
#### 1. Setting license key in `.env` file (recommended)
|
|
198
|
+
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
199
199
|
|
|
200
200
|
<AddedIn version="2.35.4" />
|
|
201
201
|
|
|
202
202
|
Create a `.env` file in the root of your project and add the following:
|
|
203
203
|
|
|
204
204
|
```bash title=".env"
|
|
205
|
-
|
|
205
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
206
206
|
```
|
|
207
207
|
|
|
208
|
-
:::tip Using an
|
|
208
|
+
:::tip Using an Older API Key?
|
|
209
209
|
|
|
210
|
-
If you
|
|
210
|
+
If you already have an older EventBridge plugin key, you can still use it with the EventBridge-specific environment variable.
|
|
211
211
|
|
|
212
|
-
```bash title="
|
|
213
|
-
|
|
212
|
+
```bash title=".env"
|
|
213
|
+
EVENTCATALOG_LICENSE_KEY_EVENTBRIDGE=your-license-key
|
|
214
214
|
```
|
|
215
215
|
|
|
216
216
|
:::
|
|
217
217
|
|
|
218
218
|
|
|
219
|
-
#### 2. Setting license key in eventcatalog.config.js
|
|
219
|
+
#### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
|
|
220
220
|
|
|
221
221
|
If you prefer, you can set the license key in the `eventcatalog.config.js` file
|
|
222
222
|
using the `licenseKey` property in the EventCatalog EventBridge plugin.
|
|
@@ -227,7 +227,7 @@ export default {
|
|
|
227
227
|
[
|
|
228
228
|
'@eventcatalog/generator-eventbridge',
|
|
229
229
|
{
|
|
230
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.
|
|
230
|
+
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
231
231
|
region: 'us-east-1',
|
|
232
232
|
registryName: 'discovered-schemas'
|
|
233
233
|
},
|
|
@@ -288,11 +288,11 @@ It's recommended you create a new IAM user with the following policy.
|
|
|
288
288
|
|
|
289
289
|
## Commercial and License
|
|
290
290
|
|
|
291
|
-
This plugin requires
|
|
291
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
292
292
|
|
|
293
|
-
You can get a
|
|
293
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
294
294
|
|
|
295
|
-
After the trial you can
|
|
295
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
296
296
|
|
|
297
297
|
See [pricing](/pricing) for more information.
|
|
298
298
|
|
|
@@ -301,17 +301,17 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
|
301
301
|
## License FAQ
|
|
302
302
|
|
|
303
303
|
### What is the license key for?
|
|
304
|
-
The license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
304
|
+
The EventCatalog Scale license key is required to use the OpenAPI plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
305
305
|
|
|
306
|
-
### How do I get
|
|
307
|
-
You can obtain
|
|
306
|
+
### How do I get an EventCatalog Scale license key?
|
|
307
|
+
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
|
|
308
308
|
|
|
309
309
|
### Terms
|
|
310
|
-
- **Trial Period**:
|
|
310
|
+
- **Trial Period**: 30-day free trial no credit card required
|
|
311
311
|
- **Support**: Discord community support (extra for priority support)
|
|
312
312
|
|
|
313
|
-
After your trial period ends, you can
|
|
313
|
+
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
314
314
|
|
|
315
315
|
## Issues
|
|
316
316
|
|
|
317
|
-
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators
|
|
317
|
+
If you have any problems or feature requests please feel free to raise them on GitHub. https://github.com/event-catalog/generators
|
|
@@ -154,7 +154,7 @@ generators: [
|
|
|
154
154
|
|
|
155
155
|
<AddedIn version="1.2.0" pkg="@eventcatalog/generator-eventbridge" url="https://github.com/event-catalog/generator-eventbridge/releases/tag/v"/>
|
|
156
156
|
|
|
157
|
-
EventCatalog [supports channels as resources](/docs/development/guides/channels/introduction). This let's you document your event buses in EventCatalog.
|
|
157
|
+
EventCatalog [supports channels as resources](/docs/development/guides/resources/messages/message-channels/introduction). This let's you document your event buses in EventCatalog.
|
|
158
158
|
|
|
159
159
|
EventCatalog will use your Event Bus as a channel, the protocol for the channel is set to `eventbridge`.
|
|
160
160
|
|
|
@@ -196,7 +196,7 @@ generators: [
|
|
|
196
196
|
|
|
197
197
|
Your markdown is persisted between generation runs on EventCatalog. Initially the generator will generate markdown for you for your domains, services and events, but any edits to the markdown file will be persisted between versions.
|
|
198
198
|
|
|
199
|
-
This allows you to add [custom components](/docs/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when your events are versioned.
|
|
199
|
+
This allows you to add [custom components](/docs/components/custom-components), our [MDX components](/docs/components) and customize your EventCatalog pages without losing changes when your events are versioned.
|
|
200
200
|
|
|
201
201
|
This can be useful for adding extra additional context to your events, example payloads, example CLI commands on how to raise them and any other useful information.
|
|
202
202
|
|
|
@@ -222,4 +222,4 @@ Any version changes here will get copied over into EventCatalog.
|
|
|
222
222
|
|
|
223
223
|
### Downloading schemas
|
|
224
224
|
|
|
225
|
-
The generator will try and download the JSONDraft4 and OpenAPI specifications for your events from EventBridge. These files will be attached to each even in EventCatalog. Users will be able to see and download these files.
|
|
225
|
+
The generator will try and download the JSONDraft4 and OpenAPI specifications for your events from EventBridge. These files will be attached to each even in EventCatalog. Users will be able to see and download these files.
|
|
@@ -142,7 +142,7 @@ The EventBridge registry name for your schemas.
|
|
|
142
142
|
|
|
143
143
|
- Type: `String`
|
|
144
144
|
|
|
145
|
-
The license key for the EventBridge generator. You can get a
|
|
145
|
+
The license key for the EventBridge generator. You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
146
146
|
|
|
147
147
|
```js title="eventcatalog.config.js"
|
|
148
148
|
[
|
|
@@ -158,7 +158,7 @@ The license key for the EventBridge generator. You can get a 14 day trial licens
|
|
|
158
158
|
You can also set the license key as an environment variable. If this is set on the machine the `licenseKey` is not required in the generator configuration.
|
|
159
159
|
|
|
160
160
|
```bash
|
|
161
|
-
|
|
161
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=YOUR_SCALE_LICENSE_KEY
|
|
162
162
|
```
|
|
163
163
|
:::
|
|
164
164
|
|
|
@@ -202,8 +202,8 @@ List of services to add and what events they publish (sends) and consume (receiv
|
|
|
202
202
|
| sends.eventBusName | optional | The name of the EventBus for the matched events. This will be displayed as an EventCatalog Channel. |
|
|
203
203
|
| receives | optional | The events the service receives (consumes). You can use [EventCatalog filters](/docs/plugins/eventbridge/intro#using-filters-to-map-events-to-your-services) to match your events. |
|
|
204
204
|
| receives.eventBusName | optional | The name of the EventBus for the matched events. This will be displayed as an EventCatalog Channel. |
|
|
205
|
-
| writesTo | optional | Array of [data stores](/docs/development/guides/data/introduction) ids that the service writes to. (Added in v3.2.2) |
|
|
206
|
-
| readsFrom | optional | Array of [data stores](/docs/development/guides/data/introduction) ids that the service reads from. (Added in v3.2.2) |
|
|
205
|
+
| writesTo | optional | Array of [data stores](/docs/development/guides/resources/data/introduction) ids that the service writes to. (Added in v3.2.2) |
|
|
206
|
+
| readsFrom | optional | Array of [data stores](/docs/development/guides/resources/data/introduction) ids that the service reads from. (Added in v3.2.2) |
|
|
207
207
|
| writeToRoot | optional | Write the service to the root of your catalog, ignoring the domain structure. [Useful if you have shared services between domains](/docs/plugins/eventbridge/03a-workflows#shared-services-between-domains) (Added in v3.3.0) |
|
|
208
208
|
|
|
209
209
|
### `domain` {#domain}
|
|
@@ -438,4 +438,4 @@ If you are using an older version of EventCatalog that does not support mdx file
|
|
|
438
438
|
|
|
439
439
|
| Property name | Required | Options | Description |
|
|
440
440
|
| ------------- | -------- | -----------| ----------------------------------------------------------------------------- |
|
|
441
|
-
| format | optional (default 'mdx') | `md`, `mdx` | Specify the format of the markdown files that are generated. |
|
|
441
|
+
| format | optional (default 'mdx') | `md`, `mdx` | Specify the format of the markdown files that are generated. |
|
|
@@ -43,8 +43,8 @@ EventCatalog Federation is powered by the [EventCatalog Federation Generator](ht
|
|
|
43
43
|
5. You use the federation generator to merge your teams catalogs into the main catalog
|
|
44
44
|
6. You setup CI/CD to keep your main catalog up to date with your teams catalogs (or just rebuild every X time)
|
|
45
45
|
|
|
46
|
-
To use the federation generator you will need
|
|
47
|
-
You can get a free
|
|
46
|
+
To use the federation generator you will need an EventCatalog Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
47
|
+
You can get a free 30-day trial Scale license key for the plugin.
|
|
48
48
|
|
|
49
49
|
You can read more documentation:
|
|
50
50
|
|
|
@@ -55,15 +55,15 @@ You can read more documentation:
|
|
|
55
55
|
|
|
56
56
|
## Commercial Use
|
|
57
57
|
|
|
58
|
-
This plugin requires
|
|
58
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
59
59
|
|
|
60
|
-
You can get a
|
|
60
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
61
61
|
|
|
62
|
-
After the trial you can
|
|
62
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
63
63
|
|
|
64
64
|
See [pricing](/pricing) for more information.
|
|
65
65
|
|
|
66
66
|
_Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
67
67
|
|
|
68
68
|
|
|
69
|
-
<a href="https://eventcatalog.cloud" target="_blank" className="bg-purple-500 hover:bg-purple-100 cursor-pointer hover:text-white !hover:underline px-2 py-1 rounded-md text-white ">Login to EventCatalog Dashboard</a>
|
|
69
|
+
<a href="https://eventcatalog.cloud" target="_blank" className="bg-purple-500 hover:bg-purple-100 cursor-pointer hover:text-white !hover:underline px-2 py-1 rounded-md text-white ">Login to EventCatalog Dashboard</a>
|
|
@@ -107,36 +107,36 @@ generators: [
|
|
|
107
107
|
|
|
108
108
|
### Configure license key
|
|
109
109
|
|
|
110
|
-
The EventCatalog Federation plugin requires
|
|
110
|
+
The EventCatalog Federation plugin requires an EventCatalog Scale license key to work with EventCatalog.
|
|
111
111
|
|
|
112
|
-
You can get a trial license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
112
|
+
You can get a trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
113
113
|
|
|
114
114
|
You have a few options for setting the license key:
|
|
115
115
|
|
|
116
116
|
1. [Setting license key in `.env` file (recommended)](#setting-license-key-in-env-file-recommended)
|
|
117
117
|
2. [Setting license key in eventcatalog.config.js](#setting-license-key-in-eventcatalogconfigjs)
|
|
118
118
|
|
|
119
|
-
#### 1. Setting license key in `.env` file (recommended)
|
|
119
|
+
#### 1. Setting license key in `.env` file (recommended) {#setting-license-key-in-env-file-recommended}
|
|
120
120
|
|
|
121
121
|
<AddedIn version="2.35.4" />
|
|
122
122
|
|
|
123
123
|
Create a `.env` file in the root of your project and add the following:
|
|
124
124
|
|
|
125
125
|
```bash title=".env"
|
|
126
|
-
|
|
126
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
:::tip Using an
|
|
129
|
+
:::tip Using an Older API Key?
|
|
130
130
|
|
|
131
|
-
If you
|
|
131
|
+
If you already have an older Federation plugin key, you can still use it with the Federation-specific environment variable.
|
|
132
132
|
|
|
133
|
-
```bash title="
|
|
134
|
-
|
|
133
|
+
```bash title=".env"
|
|
134
|
+
EVENTCATALOG_LICENSE_KEY_FEDERATION=your-license-key
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
:::
|
|
138
138
|
|
|
139
|
-
#### 2. Setting license key in eventcatalog.config.js
|
|
139
|
+
#### 2. Setting license key in eventcatalog.config.js {#setting-license-key-in-eventcatalogconfigjs}
|
|
140
140
|
|
|
141
141
|
If you prefer, you can set the license key in the `eventcatalog.config.js` file
|
|
142
142
|
using the `licenseKey` property in the EventCatalog Federation plugin.
|
|
@@ -147,7 +147,7 @@ export default {
|
|
|
147
147
|
[
|
|
148
148
|
'@eventcatalog/generator-federation',
|
|
149
149
|
{
|
|
150
|
-
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.
|
|
150
|
+
licenseKey: '[INSERT_YOUR_LICENSE_KEY]', // or process.env.EVENTCATALOG_SCALE_LICENSE_KEY
|
|
151
151
|
},
|
|
152
152
|
],
|
|
153
153
|
],
|
|
@@ -179,4 +179,3 @@ npm run dev
|
|
|
179
179
|
If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).
|
|
180
180
|
|
|
181
181
|
|
|
182
|
-
|
|
@@ -12,7 +12,7 @@ import Beta from '@site/src/components/MDX/Beta';
|
|
|
12
12
|
|
|
13
13
|
<!-- <Beta /> -->
|
|
14
14
|
<AddedIn version="2.18.0" />
|
|
15
|
-
<PluginLicense url="/docs/
|
|
15
|
+
<PluginLicense url="/docs/plugins/eventcatalog-federation/intro#commercial-use" />
|
|
16
16
|
|
|
17
17
|
EventCatalog Federation is powered by the [EventCatalog Federation Generator](https://github.com/event-catalog/generators), this let's you define the repositories you want to merge into your main catalog.
|
|
18
18
|
|
|
@@ -162,7 +162,7 @@ If you want to learn more about the federation generator you can read the [Event
|
|
|
162
162
|
|
|
163
163
|
### Running the generator
|
|
164
164
|
|
|
165
|
-
You will need
|
|
165
|
+
You will need an EventCatalog Scale license key to run the generator. You can get a free 30-day trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
166
166
|
|
|
167
167
|
Once you have configured the federation generator you can run the generator.
|
|
168
168
|
|
|
@@ -12,7 +12,7 @@ import Beta from '@site/src/components/MDX/Beta';
|
|
|
12
12
|
|
|
13
13
|
<!-- <Beta /> -->
|
|
14
14
|
<AddedIn version="2.18.0" />
|
|
15
|
-
<PluginLicense url="/docs/
|
|
15
|
+
<PluginLicense url="/docs/plugins/eventcatalog-federation/intro#commercial-use" />
|
|
16
16
|
|
|
17
17
|
Multiple teams can own their own EventCatalog, this is useful if you have multiple teams that want to own their own EventCatalog / Documentation.
|
|
18
18
|
|
|
@@ -39,10 +39,10 @@ Your team can document their own services, messages and domains in this catalog,
|
|
|
39
39
|
To help you get started:
|
|
40
40
|
|
|
41
41
|
- [Creating domains in EventCatalog](/docs/development/guides/domains/introduction)
|
|
42
|
-
- [Creating services in EventCatalog](/docs/development/guides/services/introduction)
|
|
43
|
-
- [Creating events in EventCatalog](/docs/development/guides/messages/events
|
|
44
|
-
- [Creating commands in EventCatalog](/docs/development/guides/messages/commands
|
|
45
|
-
- [Creating queries in EventCatalog](/docs/development/guides/messages/queries
|
|
42
|
+
- [Creating services in EventCatalog](/docs/development/guides/resources/services/introduction)
|
|
43
|
+
- [Creating events in EventCatalog](/docs/development/guides/resources/messages/message-types/events)
|
|
44
|
+
- [Creating commands in EventCatalog](/docs/development/guides/resources/messages/message-types/commands)
|
|
45
|
+
- [Creating queries in EventCatalog](/docs/development/guides/resources/messages/message-types/queries)
|
|
46
46
|
|
|
47
47
|
Once your teams have created their own documentation you can [merge them into the main catalog using the federation generator](https://github.com/event-catalog/generators).
|
|
48
48
|
|
|
@@ -94,4 +94,3 @@ dependencies: {
|
|
|
94
94
|
// rest of your config
|
|
95
95
|
```
|
|
96
96
|
|
|
97
|
-
|
|
@@ -64,11 +64,11 @@ Any documentation you add to your schemas in EventCatalog will persist between b
|
|
|
64
64
|
|
|
65
65
|
## Commercial and License
|
|
66
66
|
|
|
67
|
-
This plugin requires
|
|
67
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
68
68
|
|
|
69
|
-
You can get a
|
|
69
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
70
70
|
|
|
71
|
-
After the trial you can
|
|
71
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
72
72
|
|
|
73
73
|
See [pricing](/pricing) for more information.
|
|
74
74
|
|
|
@@ -81,13 +81,13 @@ If you would like a demo of the plugin, please feel free to reach out to us and
|
|
|
81
81
|
## License FAQ
|
|
82
82
|
|
|
83
83
|
### What is the license key for?
|
|
84
|
-
The license key is required to use the GitHub plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
84
|
+
The EventCatalog Scale license key is required to use the GitHub plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
85
85
|
|
|
86
|
-
### How do I get
|
|
87
|
-
You can obtain
|
|
86
|
+
### How do I get an EventCatalog Scale license key?
|
|
87
|
+
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
|
|
88
88
|
|
|
89
89
|
### Terms
|
|
90
|
-
- **Trial Period**:
|
|
90
|
+
- **Trial Period**: 30-day free trial no credit card required
|
|
91
91
|
- **Support**: Discord community support (extra for priority support)
|
|
92
92
|
|
|
93
|
-
After your trial period ends, you can
|
|
93
|
+
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
@@ -198,15 +198,25 @@ In this example we:
|
|
|
198
198
|
|
|
199
199
|
The EventCatalog GitHub plugin requires API keys in your environment variables.
|
|
200
200
|
|
|
201
|
-
1.
|
|
201
|
+
1. An EventCatalog Scale license key for the GitHub plugin (30-day trial, at [EventCatalog Cloud](https://eventcatalog.cloud))
|
|
202
202
|
|
|
203
203
|
Create a `.env` file in the root, and add your keys to the project.
|
|
204
204
|
|
|
205
205
|
```bash title=".env"
|
|
206
206
|
# EventCatalog license key
|
|
207
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
:::tip Using an Older API Key?
|
|
211
|
+
|
|
212
|
+
If you already have an older GitHub plugin key, you can still use it with the plugin-specific environment variable.
|
|
213
|
+
|
|
214
|
+
```bash title=".env"
|
|
207
215
|
EVENTCATALOG_LICENSE_KEY_GITHUB=your-license-key
|
|
208
216
|
```
|
|
209
217
|
|
|
218
|
+
:::
|
|
219
|
+
|
|
210
220
|
#### White listing EventCatalog domains
|
|
211
221
|
|
|
212
222
|
If you are behind a firewall you will need to white list the domain `https://api.eventcatalog.cloud` in your firewall. This is because the plugin needs to verify your license key.
|
|
@@ -225,7 +235,7 @@ Set the `EVENTCATALOG_GITHUB_TOKEN` environment variable in your `.env` file.
|
|
|
225
235
|
|
|
226
236
|
```bash title=".env"
|
|
227
237
|
# EventCatalog license key
|
|
228
|
-
|
|
238
|
+
EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
|
|
229
239
|
|
|
230
240
|
# GitHub token for private repository access
|
|
231
241
|
EVENTCATALOG_GITHUB_TOKEN=ghp_your_token_here
|
|
@@ -288,6 +298,3 @@ npm run build
|
|
|
288
298
|
If you get stuck, find an issue or need help, please raise an issue on [GitHub](https://github.com/event-catalog/eventcatalog/issues) or join our [Discord community](https://eventcatalog.dev/discord).
|
|
289
299
|
|
|
290
300
|
You can also find some examples of the plugin in action in our examples repository: [eventcatalog/examples](https://github.com/event-catalog/generators/tree/main/examples/generator-github).
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
@@ -49,11 +49,11 @@ This let's you visualize your architecture, assign owners to your services and m
|
|
|
49
49
|
|
|
50
50
|
## Commercial and License
|
|
51
51
|
|
|
52
|
-
This plugin requires
|
|
52
|
+
This plugin requires an EventCatalog Scale license key to be used.
|
|
53
53
|
|
|
54
|
-
You can get a
|
|
54
|
+
You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
|
|
55
55
|
|
|
56
|
-
After the trial you can
|
|
56
|
+
After the trial, you can continue using this plugin with EventCatalog Scale.
|
|
57
57
|
|
|
58
58
|
See [pricing](/pricing) for more information.
|
|
59
59
|
|
|
@@ -62,13 +62,13 @@ _Have any questions? You can email us at `hello@eventcatalog.dev`._
|
|
|
62
62
|
## License FAQ
|
|
63
63
|
|
|
64
64
|
### What is the license key for?
|
|
65
|
-
The license key is required to use the GraphQL plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
65
|
+
The EventCatalog Scale license key is required to use the GraphQL plugin with EventCatalog. It helps support ongoing development and maintenance of the plugin and project.
|
|
66
66
|
|
|
67
|
-
### How do I get
|
|
68
|
-
You can obtain
|
|
67
|
+
### How do I get an EventCatalog Scale license key?
|
|
68
|
+
You can obtain an EventCatalog Scale license key by visiting [EventCatalog Cloud](https://eventcatalog.cloud). New users can start with a 30-day free trial.
|
|
69
69
|
|
|
70
70
|
### Terms
|
|
71
|
-
- **Trial Period**:
|
|
71
|
+
- **Trial Period**: 30-day free trial no credit card required
|
|
72
72
|
- **Support**: Discord community support (extra for priority support)
|
|
73
73
|
|
|
74
|
-
After your trial period ends, you can
|
|
74
|
+
After your trial period ends, you can continue with EventCatalog Scale through [EventCatalog Cloud](https://eventcatalog.cloud).
|