Skip to content

[Enhancement]: Replace the deprecated Registry Server quickstart with Helm #1048

Description

@danbarr

Page or section

https://docs.stacklok.com/toolhive/guides-registry/quickstart

What could be better?

The primary Registry Server quickstart teaches the deprecated MCPRegistry custom resource and ToolHive Operator workflow. The section landing page sends new readers to this tutorial first, while the deployment documentation recommends the standalone toolhive-registry-server Helm chart for new deployments.

This makes the first hands-on experience a legacy path that readers should not adopt for long-lived deployments. The page also ends with five Next steps links, while the documentation guidelines call for 1-3 links that provide a clear forward path.

Proposed improvement

Rewrite the quickstart around the official Registry Server Helm chart while preserving its current learning outcome:

  • Create a local kind cluster.
  • Deploy a minimal PostgreSQL database.
  • Define a file-based registry source.
  • Install the Registry Server with the official Helm chart.
  • Query the Registry API.
  • Clean up the local resources.

Keep the tutorial focused on a fast local evaluation with anonymous authentication. Reduce the Next steps section to 1-3 links, prioritizing production deployment, authentication, and source configuration.

The deprecated Operator workflow should remain documented in the dedicated Operator deployment and migration guides, not in the default quickstart.

Additional context

The Helm deployment guide already contains the recommended chart and configuration structure:

https://docs.stacklok.com/toolhive/guides-registry/deploy-helm

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requestneeds-triageIssue needs initial triage by a maintainer

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions