Tool usage page: fix time range claims and add utility
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
docs/connector-gateway/tool-usage.mdx を、指定された行と現在のページ構成を起点に編集します。時間範囲と UI の文言を更新し、このページで管理者のどのような疑問を解決できるかを説明し、指定された使用状況の詳細へのリンクを追加して、トラブルシューティングを独立したセクションに移動します。#1179 で確認でき次第、Metering の前提条件を含めます。推奨事項がページに正確に反映されたら完了です。
索引モデルが issue の本文から書いたものです。
説明
Part of #1175. Page: docs/connector-gateway/tool-usage.mdx
Problems
- The time range claim is misleading (lines 12-13). The page implies the time range controls everything on the screen. The options are Last 24h, Last 7d, and Last 30d, with 24h the default. They drive the tiles and the tables, but the Tool calls trend chart always shows Last 3 months, whatever range is selected.
- The page doesn't help the reader answer anything. It lists what's on screen, but not what an admin can learn from it, such as which connectors are unused, where adoption is growing, or which tools are called most. It doesn't mention drill-down either. Connector names in the tables aren't links, and per-user detail is only on each connector's Activity tab.
- Troubleshooting is mixed into the body (lines 20-22), and it leaves out the most likely cause of an empty screen: the metering prerequisite tracked in #1179.
- Minor:
- The console title is Tool Usage (title case). Match it when bolding the UI label.
- Line 15 says "integrations". Use "connectors".
Recommendations
- List the time range options and the default, and state that the chart's window is fixed at 3 months
- Document the tiles (Tool calls, Active connectors, Top connector) and the table columns (By connector: Connector, Calls, Share; By tool: Tool, Connector, Calls, Share)
- Frame the page around two or three admin questions it answers
- Link to the connector Activity tab for per-user and per-call detail
- Mention that users see their own usage on the Usage tab in the User experience
- Move lines 20-22 into a Troubleshooting section, and add the metering prerequisite once #1179 confirms it
- 主要言語
- JavaScript
- スター
- 4
- フォーク
- 4
- 平均マージ
- 1日 1時間
- マージ済み PR(30日)
- 58
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stacklok/docs-website のほかの issue
-
documentation enhancement needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
stacklok/docs-website#1241 ·
メンテナーはふだん 1 日以内に返信
-
bug documentation needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
stacklok/docs-website#1149 · コメント 2 件 ·
メンテナーはふだん 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 日以内に返信
-
documentation enhancement needs-triage
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
stacklok/docs-website#1243 ·
メンテナーはふだん 1 日以内に返信
stacklok/docs-website の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
taskcluster/taskcluster#9284 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Spomky-Labs/pwa-bundle#476 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
speced/respec#5504 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信