Skip to content

Commit 3661e82

Browse files
committed
docs(FR-2537): add board customization and auto-refresh to dashboard docs (#6781)
Resolves #6681 (FR-2537) ## Summary - Document **board customization** via drag-and-drop on the Dashboard page - Document the **auto-refresh** toggle and 15-second refresh interval - Remove references to the Superadmin Dashboard per reviewer feedback (feature is hidden in current UI) ## Changes - `dashboard/dashboard.md` (en/ko/ja/th): board customization section, auto-refresh note, removed Superadmin Dashboard section and cross-references ## Context This PR re-creates the #6575 work after the original PR was accidentally squash merged with 29 commits from its ancestor PRs (reverted in #6780). Now scoped to dashboard.md only, stacked on top of #6574's branch. ## Test plan - [ ] Verify drag-and-drop board customization behavior is accurately described - [ ] Verify auto-refresh interval (15 seconds) matches the actual UI - [ ] Confirm Superadmin Dashboard removal is correct across all 4 languages
1 parent bfeea9f commit 3661e82

4 files changed

Lines changed: 43 additions & 77 deletions

File tree

packages/backend.ai-webui-docs/src/en/dashboard/dashboard.md

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ The page is composed of several main panels:
2828
Summarizes the overall used and free resources in the selected resource group.
2929
The data is aggregated from all agents that belong to the group.
3030

31+
:::note
32+
The **Total Resources in Resource Group** panel may not be visible depending on your
33+
system configuration.
34+
:::
35+
3136
- **Recently Created Sessions**:
3237
Lists the most recently created active sessions within the current project.
3338
Provides session details such as name, status, CPU/memory usage, environment, resource group,
@@ -36,7 +41,7 @@ The page is composed of several main panels:
3641

3742
## Auto-Refresh
3843

39-
The Dashboard automatically refreshes all panel data every 15 seconds. This
44+
The Dashboard automatically refreshes all panel data every **15 seconds**. This
4045
ensures that the displayed information stays up to date without requiring manual
4146
interaction.
4247

@@ -53,22 +58,7 @@ Your customized layout is automatically saved and persists across browser
5358
sessions. The layout is stored per user, so each user can have their own
5459
preferred arrangement.
5560

56-
## Superadmin Dashboard
57-
58-
For superadmins, additional panels are available.
59-
60-
![](../images/admin_dashboard.png)
61-
62-
Except for **Active Sessions**, **Agent Statistics**, and **Active Agents**, the remaining panels
63-
display the same information as the user dashboard.
64-
65-
- **Active Sessions**:
66-
Shows the total number of active sessions across current projects,
67-
categorized by session type.
68-
69-
- **Agent Statistics**:
70-
Provides all used resources across all agents in the system.
71-
The values represent the total used resources by all active sessions.
72-
73-
- **Active Agents**:
74-
Lists all currently active agents in the system.
61+
:::tip
62+
When the WebUI is updated with new dashboard panels, those panels will
63+
automatically appear on your dashboard even if you have a saved custom layout.
64+
:::

packages/backend.ai-webui-docs/src/ja/dashboard/dashboard.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,28 @@
66

77
このページは以下の主要パネルで構成されています:
88

9-
- **マイセッション:**
9+
- **私のセッション:**
1010
インタラクティブ、バッチ、推論、アップロードなど、タイプ別にアクティブなセッション数を表示します。各タイプのセッションがいくつ実行中かをすばやく確認できます。
1111

12-
- **マイ総リソース上限:**
12+
- **私の総リソース制限:**
1313
すべてのプロジェクトとリソースグループを合算した総使用量と空きリソースを表示します。ドメイン、プロジェクト、キーペアなど複数の上限が同時に適用される場合、システムは**最も制限的な上限**を基準に残りのリソースを計算します。
1414

15-
- **リソースグループ内のマイリソース:**
15+
- **リソースグループの私のリソース:**
1616
現在のプロジェクトの選択されたリソースグループにおけるリソース使用量と残りの容量を表示します。ドロップダウンメニューでグループを切り替えることができます。
1717

18-
- **リソースグループ内の総リソース:**
18+
- **リソースグループの総リソース:**
1919
選択されたリソースグループ全体の使用量と空き容量を要約表示します。グループに属するすべてのエージェントのデータを集計した値です。
2020

21+
:::note
22+
**リソースグループの総リソース**パネルは、システム構成によって表示されない場合があります。
23+
:::
24+
2125
- **最近作成されたセッション:**
2226
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。セッション名、ステータス、CPU/メモリ使用量、環境、リソースグループ、セッションタイプ、作成日時などの詳細を確認できます。デフォルトでは最新の5つのアクティブなセッションが表示されます。
2327

2428
## 自動更新
2529

26-
ダッシュボードは15秒ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
30+
ダッシュボードは**15秒**ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
2731

2832
## ダッシュボードレイアウトのカスタマイズ
2933

@@ -34,19 +38,7 @@
3438

3539
カスタマイズされたレイアウトは自動的に保存され、ブラウザセッション間で保持されます。レイアウトはユーザーごとに保存されるため、各ユーザーが独自の配置を設定できます。
3640

37-
## スーパー管理者ダッシュボード
38-
39-
スーパー管理者には追加のパネルが利用可能です。
40-
41-
![](../images/admin_dashboard.png)
42-
43-
**アクティブセッション****エージェント統計****アクティブエージェント**を除く残りのパネルは、ユーザーダッシュボードと同じ情報を表示します。
44-
45-
- **アクティブセッション:**
46-
現在のプロジェクトのアクティブなセッション総数をセッションタイプ別に分類して表示します。
47-
48-
- **エージェント統計:**
49-
システム内のすべてのエージェントで使用中のリソース状況を提供します。表示される値は、すべてのアクティブなセッションが使用しているリソースの総量です。
50-
51-
- **アクティブエージェント:**
52-
システムで現在アクティブなすべてのエージェントの一覧を表示します。
41+
:::tip
42+
WebUIの更新で新しいダッシュボードパネルが追加された場合、保存済みのカスタムレイアウトが
43+
あっても、新しいパネルは自動的にダッシュボードに表示されます。
44+
:::

packages/backend.ai-webui-docs/src/ko/dashboard/dashboard.md

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,22 @@
1414
- **나의 총자원 제한:**
1515
모든 프로젝트와 자원 그룹을 합산한 전체 자원 사용량과 남은 자원을 표시합니다. 도메인, 프로젝트, 키페어 등 여러 한도 제한이 동시에 적용될 경우, **가장 제한적인 한도**를 기준으로 계산됩니다.
1616

17-
- **자원 그룹별 나의 자원:**
17+
- **자원 그룹 내 나의 자원:**
1818
현재 프로젝트의 선택된 자원 그룹에서 사용 중인 자원과 남은 자원을 표시합니다. 상단의 드롭다운 메뉴를 통해 자원 그룹을 변경할 수 있습니다.
1919

20-
- **자원 그룹별 총자원:**
20+
- **자원 그룹 내 총자원:**
2121
선택된 자원 그룹 전체의 사용량과 가용량을 요약하여 표시합니다. 그룹 내 모든 에이전트의 데이터를 합산해 계산된 값입니다.
2222

23+
:::note
24+
**자원 그룹 내 총자원** 패널은 시스템 구성에 따라 표시되지 않을 수 있습니다.
25+
:::
26+
2327
- **최근 생성 세션:**
2428
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다. 세션 이름, 상태, CPU/메모리 사용량, 환경, 자원 그룹, 세션 유형, 생성 일시 등을 확인할 수 있습니다. 기본적으로 최근 5개의 실행 중인 세션이 표시됩니다.
2529

2630
## 자동 새로고침
2731

28-
대시보드는 모든 패널 데이터를 15초마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
32+
대시보드는 모든 패널 데이터를 **15초**마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
2933

3034
## 대시보드 레이아웃 커스터마이즈
3135

@@ -36,19 +40,7 @@
3640

3741
커스터마이즈된 레이아웃은 자동으로 저장되어 브라우저 세션 간에 유지됩니다. 레이아웃은 사용자별로 저장되므로, 각 사용자가 자신만의 배치를 설정할 수 있습니다.
3842

39-
## 슈퍼관리자 대시보드
40-
41-
슈퍼관리자에게는 추가 패널이 제공됩니다.
42-
43-
![](../images/admin_dashboard.png)
44-
45-
**활성 세션**, **에이전트 통계**, **활성 에이전트** 패널을 제외한 나머지 패널은 사용자 대시보드와 동일한 정보를 표시합니다.
46-
47-
- **활성 세션:**
48-
현재 프로젝트에서 실행 중인 세션의 총 개수를 세션 유형별로 분류하여 표시합니다.
49-
50-
- **에이전트 통계:**
51-
시스템 내 모든 에이전트의 사용 중인 자원 현황을 제공합니다. 표시된 값은 모든 활성 세션이 사용 중인 자원의 총합입니다.
52-
53-
- **활성 에이전트:**
54-
시스템에서 현재 활성화된 모든 에이전트 목록을 표시합니다.
43+
:::tip
44+
WebUI 업데이트로 새로운 대시보드 패널이 추가되면, 저장된 커스텀 레이아웃이 있더라도
45+
새 패널이 대시보드에 자동으로 표시됩니다.
46+
:::

packages/backend.ai-webui-docs/src/th/dashboard/dashboard.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,16 @@
1818
- **ทรัพยากรรวมในกลุ่มทรัพยากร:**
1919
สรุปทรัพยากรที่ใช้แล้วและว่างโดยรวมในกลุ่มทรัพยากรที่เลือก ข้อมูลรวบรวมจากเอเจนต์ทั้งหมดที่อยู่ในกลุ่ม
2020

21+
:::note
22+
แผง**ทรัพยากรรวมในกลุ่มทรัพยากร**อาจไม่แสดงขึ้นอยู่กับการกำหนดค่าระบบ
23+
:::
24+
2125
- **เซสชันที่สร้างล่าสุด:**
2226
แสดงรายการเซสชันที่ใช้งานอยู่ที่สร้างล่าสุดภายในโปรเจกต์ปัจจุบัน แสดงรายละเอียดเซสชัน เช่น ชื่อ สถานะ การใช้ CPU/หน่วยความจำ สภาพแวดล้อม กลุ่มทรัพยากร ประเภทเซสชัน และเวลาที่สร้าง โดยค่าเริ่มต้นจะแสดงเซสชันที่ใช้งานอยู่ล่าสุด 5 รายการ
2327

2428
## การรีเฟรชอัตโนมัติ
2529

26-
แดชบอร์ดจะรีเฟรชข้อมูลทุกแผงอัตโนมัติทุก 15 วินาที เพื่อให้ข้อมูลที่แสดงเป็นปัจจุบันอยู่เสมอโดยไม่ต้องดำเนินการด้วยตนเอง
30+
แดชบอร์ดจะรีเฟรชข้อมูลทุกแผงอัตโนมัติทุก **15 วินาที** เพื่อให้ข้อมูลที่แสดงเป็นปัจจุบันอยู่เสมอโดยไม่ต้องดำเนินการด้วยตนเอง
2731

2832
## การปรับแต่งเลย์เอาท์แดชบอร์ด
2933

@@ -34,19 +38,7 @@
3438

3539
เลย์เอาท์ที่ปรับแต่งแล้วจะถูกบันทึกอัตโนมัติและคงอยู่ระหว่างเซสชันของเบราว์เซอร์ เลย์เอาท์จะถูกจัดเก็บตามผู้ใช้ ดังนั้นผู้ใช้แต่ละคนสามารถมีการจัดเรียงที่ต้องการของตนเองได้
3640

37-
## แดชบอร์ดสำหรับผู้ดูแลระบบระดับสูง
38-
39-
สำหรับผู้ดูแลระบบระดับสูง จะมีแผงเพิ่มเติมให้ใช้งาน
40-
41-
![](../images/admin_dashboard.png)
42-
43-
ยกเว้น **เซสชันที่ใช้งานอยู่**, **สถิติเอเจนต์** และ **เอเจนต์ที่ใช้งานอยู่** แผงที่เหลือจะแสดงข้อมูลเดียวกันกับแดชบอร์ดของผู้ใช้ทั่วไป
44-
45-
- **เซสชันที่ใช้งานอยู่:**
46-
แสดงจำนวนเซสชันที่ใช้งานอยู่ทั้งหมดในโปรเจกต์ปัจจุบัน จำแนกตามประเภทเซสชัน
47-
48-
- **สถิติเอเจนต์:**
49-
แสดงทรัพยากรที่ใช้แล้วทั้งหมดในเอเจนต์ทุกตัวของระบบ ค่าที่แสดงแสดงถึงทรัพยากรรวมที่ใช้โดยเซสชันที่ใช้งานอยู่ทั้งหมด
50-
51-
- **เอเจนต์ที่ใช้งานอยู่:**
52-
แสดงรายการเอเจนต์ทั้งหมดที่ใช้งานอยู่ในระบบปัจจุบัน
41+
:::tip
42+
เมื่อ WebUI ได้รับการอัปเดตพร้อมแผงแดชบอร์ดใหม่ แผงเหล่านั้นจะปรากฏบนแดชบอร์ด
43+
ของคุณโดยอัตโนมัติ แม้ว่าคุณจะมีเลย์เอาท์ที่บันทึกไว้แล้วก็ตาม
44+
:::

0 commit comments

Comments
 (0)