Skip to main content

<ResourceLink />

The <ResourceLink/> component renders a link to a resource in EventCatalog.

Support

The <ResourceLink/> component is supported on all EventCatalog pages.

Usage

  1. Include the <ResourceLink/> component inside the markdown
    • e.g /domains/MyDomain/index.mdx

Basic Example

---
#domain frontmatter
---

<!-- No version specified, so the latest version is used -->
<ResourceLink id="InventoryService" type="service" />

<!-- Specifying a version, will link to that version of the resource -->
<ResourceLink id="InventoryService" type="service" version="1.0.0" />

<!-- Specifying a child element will render that element as the link text -->
<ResourceLink id="InventoryService" type="service">This is a custom link</ResourceLink>

Props

NameTypeDefaultRequiredDescription
idstringnoneYesId of the resource group to render.
typestringnoneYesThe type of resource to render (service, event, query, command, channel, flow, domain, user, team)
versionstringnoneOptional. The version of the resource to render, by default the latest version is used.Version of the resource to link to.