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

Tool usage page: fix time range claims and add utility

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#1,185 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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/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

Chỉnh sửa docs/connector-gateway/tool-usage.mdx, bắt đầu với các dòng được liệt kê và cấu trúc hiện tại của trang. Cập nhật cách diễn đạt về khoảng thời gian và UI, giải thích trang này giúp trả lời những câu hỏi nào của quản trị viên, thêm các liên kết chi tiết về cách sử dụng được chỉ định và chuyển phần khắc phục sự cố sang một mục riêng. Thêm điều kiện tiên quyết về metering sau khi #1179 xác nhận điều đó; hoàn tất khi các đề xuất được phản ánh chính xác trên trang.

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

Mô tả

bug documentation needs-triage

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

Problems

  1. 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.
  2. 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.
  3. 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.
  4. 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
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.