Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Connector Gateway intro: add how it works and full admin scope

Đã đóng
  • Có gì không ổn?
#1,183 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Một pull request liên quan đã được merge.

  • #1205 của @tgrunnagle — đã merge

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Start with docs/connector-gateway/index.mdx and inspect connectorGatewaySidebar plus the configure page's flow diagram. Review #1176 and #1177 for prerequisite and policy context, then update the introduction, admin-area links, prerequisites, and vMCP comparison. Done means the page explains the request flow and roles, lists all four admin areas, and avoids duplicated pointers.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation enhancement needs-triage

Part of #1175. Page: docs/connector-gateway/index.mdx

Problems

  1. It doesn't explain how the gateway works or who does what (lines 18-24). The page says what the gateway is, but not how anyone gets value from it. There are two roles:

    • Admins register connectors and grant access.
    • Users connect an MCP client (Claude Code, Claude, Codex, Cursor, VS Code) to a single gateway endpoint and sign in once per connector.

    The only diagram of the flow is on the configure page.

  2. "What you administer here" is incomplete, and the sidebar doesn't match the console (lines 38-42). In the console, the Connectors admin nav group has four items: Connectors, Identity Providers, Managed Secrets, and Tool Usage. The docs put identity providers and managed secrets under Platform → Identity and directory, and this list doesn't mention them.

  3. The vMCP comparison implies a difference that isn't there (line 32). It lists "multiple authentication methods" as a vMCP advantage, but the Connector Gateway supports five auth types in the console and eight through the API.

  4. The directory-groups pointer repeats at lines 19 and 49-51, and access is also policy-based (see #1177). "Before you start" (lines 44-47) is a single link.

Recommendations

  • Add a short "How it works" section: the request flow (client → gateway → directory policy → connector), plus the admin and user roles, with links to each
  • List all four admin areas with links. Consider adding sidebar links to the identity providers and managed secrets pages in connectorGatewaySidebar.
  • Turn the vMCP section into a comparison table covering:
    • who picks the tools: admins and users vs. a fixed config
    • how authorization works: per-user connector policy vs. ToolhiveAuthorizationPolicy
    • tool filtering and renaming: users narrow their own tools vs. admin-defined
    • who it's for: people vs. applications
  • Link ToolhiveAuthorizationPolicy
  • Replace "Before you start" with real prerequisites: gateway deployed (#1176), at least one directory group, and identity providers or managed secrets for connectors that need auth
  • State the directory-groups pointer once
Ngôn ngữ chính
JavaScript
Star
4
Fork
4
Merge trung bình
1 ngày 1 giờ
Pull request đã merge (30 ngày)
58

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của stacklok/docs-website

Tất cả issue của stacklok/docs-website

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.