Skip to content

Add guidance on when to deploy the Registry Server - #1355

Merged
danbarr merged 3 commits into
mainfrom
registry-server-decision-guide
Nov 18, 2026
Merged

danbarr merged 3 commits into
mainfrom
registry-server-decision-guide

Conversation

@danbarr

@danbarr danbarr commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Description

The Registry Server is an optional platform component, but the docs don't say when a deployment needs it alongside the Connector Gateway's connector catalog. Now that the console has no direct registry management, the two catalogs are easy to confuse.

This adds a concept page, "When to deploy the Registry Server," with:

  • A comparison of what each catalog manages, holds, and serves
  • A decision matrix mapping common requirements (ITSM-based approval, internal publishing and versioning, split vetting and provisioning teams, shared catalogs across deployments, local-client enforcement, skills and plugins) to a recommendation
  • How Import from registry works: a one-time prefill from the latest entry, with no ongoing link between the connector and the entry
  • Guidance on keeping connectors in sync with approved records, whether those live in the Registry Server or an ITSM process, including creating drafts through the Enterprise Manager API as a reviewed handoff
  • Two operating models: platform/engineering-owned and IT-owned

It also links the page from the platform setup overview, Configure the Registry Server, and the import section of Manage connectors.

Type of change

  • New documentation

Related issues/PRs

Screenshots

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Navigation

  • New pages include a frontmatter section with title and description at a minimum
  • Sidebar navigation (sidebars.ts) updated for added, deleted, reordered, or renamed files

Reviewer checklist

Content

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

New concept page with a decision matrix for the optional Registry
Server versus the Connector Gateway's connector catalog, how registry
imports reach the catalog, and keeping connectors in sync with
approved records. Link it from the platform setup, Registry Server,
and connectors pages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 17, 2026 21:29
@vercel

vercel Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs-website Ready Ready Preview Nov 17, 2026 10:28pm UTC

Request Review

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

The documentation implies every published version is retained, but catalog synchronization removes versions absent upstream, potentially misleading readers about preserved approval history.

1 open issue
What changed in this PR

This PR helps platform administrators decide when the optional Registry Server adds value alongside the Connector Gateway's connector catalog.

Changes:

  • Adds a catalog comparison, decision matrix, and operating models.
  • Explains one-time registry imports and how to keep connectors aligned with approved records.
  • Links the guidance from platform setup, registry configuration, connector management, and sidebar navigation.
File Description
sidebars.ts Adds the concept page to platform navigation.
docs/​platform/​enterprise-platform/​index.mdx Links deployment decisions to the new guidance.
docs/​platform/​enterprise-platform/​configure-registry-server.mdx Clarifies optional deployment and links the comparison.
docs/​platform/​concepts/​registry-server-and-connector-catalog.mdx Adds deployment criteria, import behavior, and ownership guidance.
docs/​connector-gateway/​connectors.mdx Explains that registry imports do not follow later entry changes.

Review effort: Balanced

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@danbarr
danbarr marked this pull request as ready for review November 17, 2026 22:21
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@danbarr
danbarr merged commit 95b8eaa into main Nov 18, 2026
14 checks passed
@danbarr
danbarr deleted the registry-server-decision-guide branch November 18, 2026 02:42

This branch was successfully deployed

1 active deployment
Preview — 8a193010 Deployed Nov 17, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants