Replace "Your workspace" with actual console navigation
メンテナーはふだん 1 日以内に返信
関連するプルリクエストがすでにマージされています。
- #1208 @tgrunnagle による — マージ済み
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 68/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
調査の方向性
Review the listed pages in docs/connector-gateway/connectors.mdx, docs/platform/enterprise-platform/roll-out-gateway-clients.mdx, docs/platform/enterprise-directory/virtual-api-keys.mdx, docs/platform/enterprise-directory/index.mdx, and docs/platform/enterprise-console/index.mdx, along with STYLE-GUIDE.md. First verify the current console navigation and labels, then update the references and document the Connectors Clients tab and supported client setup guidance. Done means no stale “Your workspace” or “Setup” references remain and the requested status and action labels are consistent.
索引モデルが issue の本文から書いたものです。
説明
Part of #1175.
Problem
The docs send users to Your workspace, and that label doesn't exist in the console. Users switch Experience to User in the account menu. The User experience has Home, plus Connectors and AI Gateway under Gateways. The Connectors area has three tabs: Tools, Usage, and Clients.
Pages that reference Your workspace, or its Setup area:
docs/connector-gateway/connectors.mdx:54docs/platform/enterprise-platform/roll-out-gateway-clients.mdx:20,40. The page's Setup is actually the Clients tab under Connectors.docs/platform/enterprise-directory/virtual-api-keys.mdx:16(API keys in Your workspace)docs/platform/enterprise-directory/index.mdx:52docs/platform/enterprise-console/index.mdx:18("switch between Administration and Your workspace")
Recommendations
-
Replace every reference with the console's actual navigation. Check the AI Gateway user area and the API keys location in the console while doing this.
-
Document the Connectors Clients tab in
roll-out-gateway-clients.mdx. It covers:- the endpoint and transport (Streamable HTTP, OAuth with dynamic client registration)
- the Ask your AI assistant prompt
- setup guides for Claude Code, Claude (web and desktop), Codex, Cursor, VS Code, and other clients
Note that Claude on the web or desktop needs the gateway to be reachable from the public internet.
-
Use the user-side status labels Connected, Paused, and Reconnect required, and the actions Connect, Reconnect, Pause/Resume, and Disconnect. The end-user page in #1179 depends on this.
-
Consider a word-list entry in STYLE-GUIDE.md for the console's two experiences, Administration and User
- 主要言語
- TypeScript
- スター
- 4
- フォーク
- 3
- 平均マージ
- 1日 1時間
- マージ済み PR（30日）
- 58
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stacklok/docs-website のほかの issue
-
bug documentation needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#1149 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
stacklok/docs-website#1143 ·
メンテナーはふだん 1 日以内に返信
-
needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#564 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
[Gap]: Configure the Connector Gateway: remaining gaps and inaccuracies at chart v0.18.0対応中かも @tgrunnagle が今日担当しました。 オープンdocumentation needs-triage
stacklok/docs-website#1225 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
-
[Enhancement]: connector-gateway fixes and improvements対応中かも @tgrunnagle が 10 日前に担当しました。 オープンdocumentation enhancement
stacklok/docs-website#1175 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
stacklok/docs-website の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
cockpit-project/cockpit-machines#2835 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
cloudflare/kumo#866 ·
メンテナーはふだん 1 日以内に返信
-
area:connector bug
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
environment: OPENCODE_API_KEY is described as a Console service account key, but a Go subscription key works対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
tester-army/e2e#1015 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信