@eventcatalog/core 4.10.13 → 4.10.14

package/dist/docs/plugins/backstage/00-intro.md

@@ -1,67 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- components
-sidebar_label: Introduction
-title: Getting started
-description: Getting started with Backstage plugin
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-import PluginLicense from '@site/src/components/MDX/PluginLicense';
-
-<PluginLicense url="#commercial-use" />
-
-<iframe width="100%" height="415" src="https://www.youtube.com/embed/mjf7qwoSAC4?si=eBZfgjMOQrD75teb" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
-
----
-
-Many folks are using [Backstage](https://backstage.spotify.com/) for their internal developer portals. Backstage is a highly configurable platform that allows you to document your architecture in components, apis, services, domains and much more.
-
-Backstage supports plugins, that have a frontend and backend support.
-
-Using the EventCatalog Backstage plugin you can embed your EventCatalog information into backstage.
-
-### Core Features
-
-The EventCatalog Backstage plugin can provide you with many features:
-
-- 📃 Bring [EventCatalog documentation](https://demo.eventcatalog.dev/docs/domains/Orders/0.0.3) into Backstage
-- 📃 Custom tabs for your APIs and Services. Embed documentation, visualizations and searchable tables.
-- 📊 Embed [EventCatalog visualizer](https://demo.eventcatalog.dev/visualiser/domains/Orders/0.0.3) into your Backstage pages
-- 🔎 Embed the [EventCatalog discovery table](https://demo.eventcatalog.dev/discover/events) to quickly find messages for your services
-- ⭐ And much more...
-
-### How it works
-
-![Example](/img/integrations/backstage/backstage-eventcatalog.png)
-
-This plugin exposes React components that you can embed on your pages to display information from EventCatalog.
-
-_Your EventCatalog has be hosted and the URL given to the app.config.yml file._
-
-- `<EventCatalogDocumentationEntityPage page="docs/page/visualiser"  />`
-  - Used to embed whole pages of EventCatalog into your Backstage instance. You can add these as tabs to your pages, clicking on the tab will show the desired feature.
-- `<EventCatalogEntityVisualiserCard />`
-  - Used to embed a widget (Card) on your existing pages. This component will display the visualiser on your page.
-- `<EventCatalogEntityMessageCard />`
-  - Used to embed a widget (Card) on your existing pages. This component will display the explore (table) on your page. Great for displaying a list of messages your service produces/consumes.
-
-_Note: If you want to embed private EventCatalog instances, raise an issue on GitHub and we can explore this_.
-
----
-
-## Commercial Use
-
-This plugin requires an EventCatalog Scale license key to be used.
-
-You can get a 30-day trial Scale license key by going to [EventCatalog Cloud](https://eventcatalog.cloud).
-
-You can try the Backstage plugin, or use EventCatalog Scale (as it's already included).
-
-After the trial, you can continue using this plugin with EventCatalog Scale. 
-
-See [pricing](/pricing) for more information.
-
-_Have any questions? You can email us at `hello@eventcatalog.dev`._
-

package/dist/docs/plugins/backstage/01-installation.md

@@ -1,242 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- components
-sidebar_label: Installation
-title: Installation
-description: Installation instructions for the EventCatalog Backstage plugin
----
-
-import AddedIn from '@site/src/components/MDX/AddedIn';
-import PluginLicense from '@site/src/components/MDX/PluginLicense';
-
-<PluginLicense url="#commercial-use" />
-
-:::info Using Backstage plugin version 1.0.0?
-
-We introduced some breaking changes in the plugin, and the ways you map your resources to EventCatalog resources.
-
-We recommend using the latest version of the plugin. You can read the [migration guide](#migrating-from--100-to-100) to help you upgrade.
-
-:::
-
----
-
-## Configuring EventCatalog for Backstage
-
-You will need an EventCatalog Scale license key to use the Backstage integration.
-
-You can get a 30-day trial Scale license key from [EventCatalog Cloud](https://eventcatalog.cloud).
-
-Once you have an EventCatalog Scale license key, you will need to build and deploy your EventCatalog with the license key set.
-
-#### 1. Setting license key in `.env` file (recommended)
-
-<AddedIn version="2.35.4" />
-
-Create a `.env` file in the root of your project and add the following:
-
-```bash title=".env"
-EVENTCATALOG_SCALE_LICENSE_KEY=your-scale-license-key
-```
-
-:::tip Using an Older API Key?
-
-If you already have an older Backstage plugin key, you can still use it with the Backstage-specific environment variable.
-
-```bash title=".env"
-EVENTCATALOG_LICENSE_KEY_BACKSTAGE=your-license-key
-```
-
-:::
-
-This will enable you to use EventCatalog within backstage.
-
-## Configuring Backstage to use EventCatalog
-
-### 1. Install the plugin on Backstage
-
-First install the plugin in your Backstage instance.
-
-```sh
-yarn add @eventcatalog/backstage-plugin-eventcatalog
-```
-
-### 2. Add the EventCatalog URL to the app-config.yaml
-
-The EventCatalog plugin needs to know the URL of your EventCatalog instance. This can be set in the `app-config.yaml` file.
-
-```yaml
-eventcatalog:
-  URL: "https://demo.eventcatalog.dev"
-```
-
-### 3. Mapping Backstage resources to EventCatalog resources with annotations
-
-Backstage and EventCatalog have different ways to create resources. For example backstage supports components, APIS, domains, systems etc, and EventCatalog supports resources (domains, services and messages (queries, commands and events)).
-
-When you configure the plugin you need to map Backstage information to EventCatalog information, so the plugin knows which EventCatalog page to render.
-
-We do this by adding annotations to the Backstage resources.
-
-<!-- Make table -->
-
-| Annotation | Required | Default | Description |
-|------------|----------|---------|-------------|
-| `eventcatalog.dev/id` | Yes | - | The id of the resource in EventCatalog |
-| `eventcatalog.dev/version` | No | `latest` | The version of the resource in EventCatalog |
-| `eventcatalog.dev/collection` | No | Uses the entity kind | The collection of the resource in EventCatalog. Options include `services`, `domains`, `queries`, `commands`, `events` |
-
-Example of creating a new service in Backstage and mapping it to an EventCatalog resource:
-
-```yaml
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: backend-service
-  description: Backend API service
-  annotations:
-    github.com/project-slug: organization/backend-repo
-    # Here we map the Backstage service to an EventCatalog resource
-    # The id of the resource in EventCatalog
-    eventcatalog.dev/id: InventoryService
-    # The version of the resource in EventCatalog
-    eventcatalog.dev/version: 0.0.2
-    # The collection of the resource in EventCatalog
-    eventcatalog.dev/collection: services
-  tags:
-    - nodejs
-    - express
-    - api
-spec:
-  type: service
-  lifecycle: production
-  owner: team-name
-  system: example-system
-  providesApis:
-    - backend-api
-  dependsOn:
-    - resource:default/database
-```
-
-### 4. Using the components in Backstage
-
-You have two options to use the components in Backstage:
-
-- [Embed EventCatalog as a tabbed page](#tabbed-pages)
-- [Embed EventCatalog as a card component](#card-components)
-
-#### Tabbed pages
-
-The `EventCatalogDocumentationEntityPage` components, is a full page component that you can assign to any `EntityLayout.Route`. 
-
-```js
-import { EventCatalogDocumentationEntityPage } from "@eventcatalog/backstage-plugin-eventcatalog";
-```
-
-You can import the `EventCatalogDocumentationEntityPage` component to render EventCatalog pages as full pages in your Backstage entity.
-
-**Rendered output example:**
-
-![EventCatalog Pages](/img/integrations/backstage/eventcatalog-pages.png)
-
-**Usage Example:**
-
-```js
-// Will create a new tab called "Docs" and route called /eventcatalog. This will embed the docs for that
-// entity in your page. Using the info from the app-config to map your Backstage ID to EventCatalog ID
-<EntityLayout.Route path="/eventcatlaog" title="Docs">
-  <EventCatalogDocumentationEntityPage page='docs' />
-</EntityLayout.Route>
-
-// Will create a new tab called "Visualzer" and route called /eventcatalog-visualizer.
-// This will embed the EventCatalog visualiser to your Backstage entity
-<EntityLayout.Route path="/eventcatlaog-visualizer" title="Visualzer">
-  <EventCatalogDocumentationEntityPage page='visualiser' />
-</EntityLayout.Route>
-
-// Will create a new tab called "Entity Map" and route called /eventcatalog-entity-map.
-// This will embed the EventCatalog entity map to your Backstage entity
-<EntityLayout.Route path="/eventcatlaog-entity-map" title="Entity Map">
-  <EventCatalogDocumentationEntityPage page='entity-map' />
-</EntityLayout.Route>
-
-// Will create a new tab called "Schema Explorer" and route called /eventcatalog-schema-explorer.
-<EntityLayout.Route path="/eventcatlaog-schema-explorer" title="Schema Explorer">
-  <EventCatalogDocumentationEntityPage page='schema-explorer' />
-</EntityLayout.Route>
-
-// Override the id, collection and version of the resource in EventCatalog
-// you can choose to override what is rendered, (not read from your backstage configuration)
-<EntityLayout.Route path="/eventcatlaog-entity-map" title="Entity Map">
-  <EventCatalogDocumentationEntityPage page='entity-map' id="MyDomainId" collection="domains" version="0.0.1" />
-</EntityLayout.Route>
-
-```
-
-#### Card components
-
-These components can be added to your pages as Cards, that can live inside the Backstage Grid System.
-
-![EventCatalog Card Components](/img/integrations/backstage/eventcatalog-card-components.png)
-![EventCatalog Card Components](/img/integrations/backstage/eventcatalog-card-component-entitymap.png)
-
-```jsx
-import {
-  EventCatalogEntityVisualiserCard,
-  EventCatalogEntityMessageCard,
-} from "@eventcatalog/backstage-plugin-eventcatalog";
-
-<Grid container spacing={3} alignItems="stretch">
-  <Grid item md={6}>
-    <!-- Backstage card -->
-    <EntityAboutCard variant="gridItem" />
-  </Grid>
-  <Grid item md={6}>
-    <!-- Adds the visualizer to a grid item in Backstage -->
-    <EventCatalogEntityVisualiserCard />
-  </Grid>
-  <Grid item md={6} xs={12}>
-    <!-- Adds the explore (messages) to a grid item in Backstage -->
-    <EventCatalogEntityMessageCard />
-  </Grid>
-  <Grid item md={6} xs={12}>
-    <!-- Adds the entity map to a grid item in Backstage -->
-    <EventCatalogEntityEntityMapCard />
-  </Grid>
-</Grid>;
-```
-
----
-
-## Migrating from < 1.0.0
-
-We introduced some breaking changes in the plugin, and the ways you map your resources to EventCatalog resources.
-
-Previously you mapped your resources to EventCatalog resources in the `app-config.yaml` file.
-
-```yaml
-eventcatalog:
-  services:
-    - backstage-name: "backend-service"
-      eventcatalog-id: "InventoryService"
-```
-
-Now you have to use annotations to map your resources to EventCatalog resources.
-
-```yaml
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: backend-service
-  annotations:
-    eventcatalog.dev/id: "InventoryService"
-    eventcatalog.dev/version: "0.0.2"
-    eventcatalog.dev/collection: "services"
-```
-
-This are the preferred ways to map your resources to EventCatalog resources and following Backstage best practices.
-
-## Demo
-
-If you want to learn how the code works in a basic demo [you can see our demo on GitHub](https://github.com/event-catalog/backstage-eventcatalog-demo).

package/dist/docs/plugins/backstage/02-api.md

@@ -1,51 +0,0 @@
----
-sidebar_position: 1
-keywords:
-  - backstage
-sidebar_label: Backstage configuration
-title: Backstage configuration
-description: Getting started with Backstage and EventCatalog plugin
----
-
-## Overview {#overview}
-
-Add the following to your `app-config.yaml` file.
-
-```yaml title="app-config.yaml"
-# Backstage configrations...
-
-# eventcatalog plugin configuration
-eventcatalog:
-  # URL of your catalog (has to be public, if private please raise and issue and we can fix this)
-  URL: "https://demo.eventcatalog.dev"
-```
-
-### Mapping your resources
-
-You can use backstage `annotations` to map your resources to EventCatalog resources.
-
-```yaml title="example-service.yaml"
-apiVersion: backstage.io/v1alpha1
-kind: Component
-metadata:
-  name: example-service
-  annotations:
-    # The id of the resource in EventCatalog
-    eventcatalog.dev/id: "example-service"
-    # The version of the resource in EventCatalog (optional, latest is used if not provided)
-    eventcatalog.dev/version: "1.0.0" 
-    # The collection of the resource in EventCatalog (optional, uses the entity kind if not provided)
-    eventcatalog.dev/collection: "services"
-```
-
-| Annotation | Required | Default | Description |
-|------------|----------|---------|-------------|
-| `eventcatalog.dev/id` | Yes | - | The id of the resource in EventCatalog |
-| `eventcatalog.dev/version` | No | `latest` | The version of the resource in EventCatalog |
-| `eventcatalog.dev/collection` | No | Uses the entity kind | The collection of the resource in EventCatalog. Options include `services`, `domains`, `queries`, `commands`, `events` |
-
-
-
-
-Looking for more mappings? Let us know! Raise an issue on [GitHub](https://github.com/event-catalog/backstage-plugin-eventcatalog).
-

package/dist/docs/plugins/backstage/03-examples.md

@@ -1,12 +0,0 @@
----
-sidebar_position: 1
-keywords:
-- components
-sidebar_label: Examples
-title: Examples
-description: Examples of using the AsyncAPI plugin
----
-
-You can find an example of how to use Backstage and EventCatalog in the [EventCatalog Backstage Demo repository](https://github.com/event-catalog/backstage-eventcatalog-demo).
-
-Or you can watch a video tutorial on [how to setup Backstage and EventCatalog](https://www.youtube.com/watch?v=mjf7qwoSAC4).

package/dist/docs/plugins/eventcatalog-federation/_category_.json

@@ -1,11 +0,0 @@
-{
-  "label": "EventCatalog Federation",
-  "position": 5,
-  "collapsible": true,
-  "collapsed": true,
-  "link": {
-    "type": "generated-index",
-    "slug": "/eventcatalog-federation",
-    "description": "Merge multiple EventCatalog instances into a single catalog."
-  }
-}