Reference
3 min read

Catalog

Use this reference to define metadata that will appear in your dashboard
Table of Contents

Conformance is available on Enterprise plans

Conformance allows you to expose metadata related to your code on the Conformance overview page so that other team memberss can discover information such as contact info, issue trackers, on-call rotations, and monitoring dashboards. You define these files next to the code that they represent.

The .vercel.catalog.json file allows you to configure metadata that will be shown on the Conformance overview in the Vercel dashboard. The available fields include:

The contact field represents the way that people should contact you if they need to reach out.

Type: Contact Object.

Valid values: A contact definition.

.vercel.catalog.json
{
  "contact": {
    "name": "#security",
    "url": "https://app.slack.com/client/...",
    "type": "slack"
  }
}
PropertyDescription
nameThe name of the link to display in the UI.
urlThe URL that this link points to.
typeSupported types are slack.

The help field represents the mechanism that people should reach out to you if they are specifically looking for help. This can be useful to differentiate from contact if you want to separate how people reach out to your team for support questions compared to other types of engagements.

Type: Help Object.

Valid values: A help definition.

.vercel.catalog.json
{
  "help": {
    "name": "#help-experiments",
    "url": "https://app.slack.com/client/...",
    "type": "slack"
  }
}
PropertyDescription
nameThe name of the link to display in the UI.
urlThe URL that this link points to.
typeSupported types are slack.

The issues field represents the location that people should file issues if they need to report any issues for the code.

Type: Issue Object.

Valid values: An issue definition.

.vercel.catalog.json
{
  "issues": {
    "name": "Monitoring Dashboard",
    "url": "https://github.com/vercel/next.js/issues",
    "type": "github"
  }
}
PropertyDescription
nameThe name of the link to display in the UI.
urlThe URL that this link points to.
typeSupported types are linear or github.

The links field represents a generic list of links that will be displayed for the code in the Vercel dashboard. This can be useful for surfacing additional links outside the above fields, such as to contributing guides, testing guidelines, or team documentation.

Type: Array of link Object.

Valid values: list of link definitions.

.vercel.catalog.json
{
  "links": [
    {
      "name": "Monitoring Dashboard",
      "url": "https://www.example.com/monitoring-dashboard"
    },
    {
      "name": "Team Documentation",
      "url": "https://www.notion.so/..."
    }
  ]
}
PropertyDescription
nameThe name of the link to display in the UI.
urlThe URL that this link points to.

Type: string

Valid values: Any string.

The name field is a unique identifier for a Catalog. It serves as a human-readable identifier, allowing you to distinguish between different Catalogs based on a descriptive label.

The production field represents information related to running this code in production, such as on-call rotations, runbooks, or the criticality of the service to your business.

Type: Production Object.

Valid values: A production definition.

.vercel.catalog.json
{
  "production": {
    "sla": "SLA_CRITICAL",
    "oncall": {
      "type": "pagerduty",
      "url": "..."
    },
    "runbook": "https://www.example.com/link-to-runbook"
  }
}
PropertyDescription
oncallA links object defining the rotation that manages production issues.
runbookThe URL to the runbooks for debugging production issues with the service.
slaThe level of criticality for this service to your business. Valid values are SLA_CRITICAL or SLA_BEST_EFFORT.
Last updated on February 21, 2024