Skip to main content

Create a user

View as Markdown

A user represents a person who owns, maintains, or can answer questions about resources in your architecture.

Example user page

Adding a new user​

Automatic Creation​

AI prompt
Create a new EventCatalog user

Copy this prompt and paste it into your coding agent. Your agent can create the user file and add the right ownership/contact metadata.

Manual Creation​

Users live in the /users folder.

Create one .mdx file for each user.

Create the user file​

Create a user file with frontmatter and markdown content.

/users/dboyne.mdx
---
# id of the user, used for references from resources
id: dboyne

# display name for the user
name: David Boyne

# optional URL path for a profile image
avatarUrl: https://github.com/dboyne.png

# user's role in the company
role: Lead developer

# optional user email address
email: david@example.com

# optional Slack URL to contact the user
slackDirectMessageUrl: https://yourteam.slack.com/team/dboyne

# optional teams this user belongs to
associatedTeams:
  - payments-platform
---

## Overview

David works on platform architecture and helps teams document their event-driven systems.

Once the file is added, the user appears in EventCatalog and can be referenced by resources or teams.

Add users to teams​

Teams can reference users in their members array:

/teams/payments-platform.mdx
---
id: payments-platform
name: Payments Platform
members:
  - dboyne
---

Next steps​