Skip to content

Commit 1aa5565

Browse files
committed
docs: add board customization and auto-refresh to dashboard docs
Resolves #6564 Add drag/resize panels, 15-second auto-refresh, localStorage persistence. Update all 4 languages.
1 parent 87e2147 commit 1aa5565

4 files changed

Lines changed: 123 additions & 92 deletions

File tree

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

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,71 @@ The **Dashboard** provides an at-a-glance summary of your current resource usage
44
available limits, and session information across all your projects and resource groups.
55
It helps you quickly understand how your computing resources are being utilized
66
and monitor your recent activities in the system.
7-
Click the refresh icon in any panel to update the displayed data if it seems outdated.
87

98
![](../images/dashboard.png)
109

1110
The page is composed of several main panels:
1211

13-
- My Sessions:
12+
- **My Sessions**:
1413
Shows the number of active sessions by type,
1514
such as *Interactive*, *Batch*, *Inference*, and *Upload*.
1615
You can quickly see how many sessions of each type are currently running.
1716

18-
- My Total Resources Limit:
17+
- **My Total Resources Limit**:
1918
Displays the total used and free resources across all your projects and resource groups.
2019
When multiple limits (domain, project, or keypair) apply,
2120
the system uses the **most restrictive** available limit to calculate the remaining resources.
2221

23-
- My Resources in Resource Group:
22+
- **My Resources in Resource Group**:
2423
Shows your current resource usage and remaining capacity
2524
within the selected resource group of your current project.
2625
You can switch groups using the dropdown menu.
2726

28-
- Total Resources in Resource Group:
27+
- **Total Resources in Resource Group**:
2928
Summarizes the overall used and free resources in the selected resource group.
3029
The data is aggregated from all agents that belong to the group.
3130

32-
- Recently Created Sessions:
31+
- **Recently Created Sessions**:
3332
Lists the most recently created active sessions within the current project.
3433
Provides session details such as name, status, CPU/memory usage, environment, resource group,
3534
session type, and creation time.
3635
By default, the latest 5 active sessions are displayed.
3736

38-
For super admins, additional information is available.
37+
## Auto-Refresh
38+
39+
The Dashboard automatically refreshes all panel data every 15 seconds. This
40+
ensures that the displayed information stays up to date without requiring manual
41+
interaction.
42+
43+
## Customizing the Dashboard Layout
44+
45+
You can customize the Dashboard layout by rearranging and resizing panels to
46+
suit your preferences.
47+
48+
- **Move panels**: Drag a panel by its header to reposition it on the board.
49+
- **Resize panels**: Drag the bottom-right corner of a panel to adjust its
50+
size. Each panel has a minimum size to ensure its content remains readable.
51+
52+
Your customized layout is automatically saved and persists across browser
53+
sessions. The layout is stored per user, so each user can have their own
54+
preferred arrangement.
55+
56+
## Superadmin Dashboard
57+
58+
For superadmins, additional panels are available.
3959

4060
![](../images/admin_dashboard.png)
4161

42-
Except for 'Active Sessions', 'Agent Statistics', and 'Active Agents', the remaining panels
62+
Except for **Active Sessions**, **Agent Statistics**, and **Active Agents**, the remaining panels
4363
display the same information as the user dashboard.
4464

45-
- Active Sessions:
65+
- **Active Sessions**:
4666
Shows the total number of active sessions across current projects,
4767
categorized by session type.
4868

49-
- Agent Statistics:
69+
- **Agent Statistics**:
5070
Provides all used resources across all agents in the system.
5171
The values represent the total used resources by all active sessions.
5272

53-
- Active Agents:
54-
Lists all currently active agents in the system.
73+
- **Active Agents**:
74+
Lists all currently active agents in the system.
Lines changed: 36 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,52 @@
1-
# Dashboard
1+
# ダッシュボード
22

3-
The **Dashboard** provides an at-a-glance summary of your current resource usage,
4-
available limits, and session information across all your projects and resource groups.
5-
It helps you quickly understand how your computing resources are being utilized
6-
and monitor your recent activities in the system.
7-
Click the refresh icon in any panel to update the displayed data if it seems outdated.
3+
**ダッシュボード**は、すべてのプロジェクトとリソースグループにおける現在のリソース使用状況、利用可能な上限、セッション情報の概要を一目で確認できるページです。コンピューティングリソースの使用状況を素早く把握し、システム内の最近の活動をモニタリングするのに役立ちます。
84

95
![](../images/dashboard.png)
106

11-
The page is composed of several main panels:
7+
このページは以下の主要パネルで構成されています:
128

13-
- My セッション:
14-
Shows the number of active sessions by type,
15-
such as *インタラクティブ*, *バッチ*, *推論*, and *Upload*.
16-
You can quickly see how many sessions of each type are currently running.
9+
- **マイセッション:**
10+
インタラクティブ、バッチ、推論、アップロードなど、タイプ別にアクティブなセッション数を表示します。各タイプのセッションがいくつ実行中かをすばやく確認できます。
1711

18-
- My Total Resources Limit:
19-
Displays the total used and free resources across all your projects and resource groups.
20-
When multiple limits (domain, project, or keypair) apply,
21-
the system uses the **most restrictive** available limit to calculate the remaining resources.
12+
- **マイ総リソース上限:**
13+
すべてのプロジェクトとリソースグループを合算した総使用量と空きリソースを表示します。ドメイン、プロジェクト、キーペアなど複数の上限が同時に適用される場合、システムは**最も制限的な上限**を基準に残りのリソースを計算します。
2214

23-
- My Resources in Resource Group:
24-
Shows your current resource usage and remaining capacity
25-
within the selected resource group of your current project.
26-
You can switch groups using the dropdown menu.
15+
- **リソースグループ内のマイリソース:**
16+
現在のプロジェクトの選択されたリソースグループにおけるリソース使用量と残りの容量を表示します。ドロップダウンメニューでグループを切り替えることができます。
2717

28-
- Total Resources in Resource Group:
29-
Summarizes the overall used and free resources in the selected resource group.
30-
The data is aggregated from all agents that belong to the group.
18+
- **リソースグループ内の総リソース:**
19+
選択されたリソースグループ全体の使用量と空き容量を要約表示します。グループに属するすべてのエージェントのデータを集計した値です。
3120

32-
- Recently Created セッション:
33-
Lists the most recently created active sessions within the current project.
34-
Provides session details such as name, status, CPU/memory usage, environment, resource group,
35-
session type, and creation time.
36-
By default, the latest 5 active sessions are displayed.
21+
- **最近作成されたセッション:**
22+
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。セッション名、ステータス、CPU/メモリ使用量、環境、リソースグループ、セッションタイプ、作成日時などの詳細を確認できます。デフォルトでは最新の5つのアクティブなセッションが表示されます。
3723

38-
For super 管理者s, additional information is available.
24+
## 自動更新
25+
26+
ダッシュボードは15秒ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
27+
28+
## ダッシュボードレイアウトのカスタマイズ
29+
30+
パネルの再配置やサイズ変更により、ダッシュボードのレイアウトをお好みに合わせてカスタマイズできます。
31+
32+
- **パネルの移動**: パネルのヘッダーをドラッグして、ボード上の位置を変更できます。
33+
- **パネルのサイズ変更**: パネルの右下隅をドラッグしてサイズを調整できます。各パネルにはコンテンツの可読性を確保するための最小サイズが設定されています。
34+
35+
カスタマイズされたレイアウトは自動的に保存され、ブラウザセッション間で保持されます。レイアウトはユーザーごとに保存されるため、各ユーザーが独自の配置を設定できます。
36+
37+
## スーパー管理者ダッシュボード
38+
39+
スーパー管理者には追加のパネルが利用可能です。
3940

4041
![](../images/admin_dashboard.png)
4142

42-
Except for 'Active セッション', 'Agent 統計', and 'Active Agents', the remaining panels
43-
display the same information as the ユーザー dashboard.
43+
**アクティブセッション****エージェント統計****アクティブエージェント**を除く残りのパネルは、ユーザーダッシュボードと同じ情報を表示します。
4444

45-
- Active セッション:
46-
Shows the total number of active sessions across current projects,
47-
categorized by session type.
45+
- **アクティブセッション:**
46+
現在のプロジェクトのアクティブなセッション総数をセッションタイプ別に分類して表示します。
4847

49-
- Agent 統計:
50-
Provides all used resources across all agents in the system.
51-
The values represent the total used resources by all active sessions.
48+
- **エージェント統計:**
49+
システム内のすべてのエージェントで使用中のリソース状況を提供します。表示される値は、すべてのアクティブなセッションが使用しているリソースの総量です。
5250

53-
- Active Agents:
54-
Lists all currently active agents in the system.
51+
- **アクティブエージェント:**
52+
システムで現在アクティブなすべてのエージェントの一覧を表示します。

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

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# 대시보드
44

5-
**대시보드** 페이지는 모든 프로젝트와 자원 그룹의 자원 사용량, 한도, 그리고 실행 중인 세션 정보를 한눈에 확인할 수 있는 종합 현황 화면입니다. 사용 중인 자원의 분포를 직관적으로 파악하고, 시스템 활동 상태를 실시간으로 모니터링할 수 있습니다. 각 패널의 새로고침 아이콘을 클릭하면 최신 데이터로 갱신할 수 있습니다.
5+
**대시보드** 페이지는 모든 프로젝트와 자원 그룹의 자원 사용량, 한도, 그리고 실행 중인 세션 정보를 한눈에 확인할 수 있는 종합 현황 화면입니다. 사용 중인 자원의 분포를 직관적으로 파악하고, 시스템 활동 상태를 실시간으로 모니터링할 수 있습니다.
66

77
![](../images/dashboard.png)
88

@@ -23,11 +23,26 @@
2323
- **최근 생성 세션:**
2424
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다. 세션 이름, 상태, CPU/메모리 사용량, 환경, 자원 그룹, 세션 유형, 생성 일시 등을 확인할 수 있습니다. 기본적으로 최근 5개의 실행 중인 세션이 표시됩니다.
2525

26-
슈퍼관리자에게는 추가 정보가 제공됩니다.
26+
## 자동 새로고침
27+
28+
대시보드는 모든 패널 데이터를 15초마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
29+
30+
## 대시보드 레이아웃 커스터마이즈
31+
32+
패널을 재배치하거나 크기를 조정하여 대시보드 레이아웃을 원하는 대로 커스터마이즈할 수 있습니다.
33+
34+
- **패널 이동**: 패널의 헤더를 드래그하여 보드 내에서 위치를 변경할 수 있습니다.
35+
- **패널 크기 조정**: 패널의 우측 하단 모서리를 드래그하여 크기를 조정할 수 있습니다. 각 패널은 콘텐츠의 가독성을 보장하기 위한 최소 크기가 설정되어 있습니다.
36+
37+
커스터마이즈된 레이아웃은 자동으로 저장되어 브라우저 세션 간에 유지됩니다. 레이아웃은 사용자별로 저장되므로, 각 사용자가 자신만의 배치를 설정할 수 있습니다.
38+
39+
## 슈퍼관리자 대시보드
40+
41+
슈퍼관리자에게는 추가 패널이 제공됩니다.
2742

2843
![](../images/admin_dashboard.png)
2944

30-
'활성 세션', '에이전트 통계', '활성 에이전트' 패널을 제외한 나머지 패널은 사용자 대시보드와 동일한 정보를 표시합니다.
45+
**활성 세션**, **에이전트 통계**, **활성 에이전트** 패널을 제외한 나머지 패널은 사용자 대시보드와 동일한 정보를 표시합니다.
3146

3247
- **활성 세션:**
3348
현재 프로젝트에서 실행 중인 세션의 총 개수를 세션 유형별로 분류하여 표시합니다.
@@ -36,4 +51,4 @@
3651
시스템 내 모든 에이전트의 사용 중인 자원 현황을 제공합니다. 표시된 값은 모든 활성 세션이 사용 중인 자원의 총합입니다.
3752

3853
- **활성 에이전트:**
39-
시스템에서 현재 활성화된 모든 에이전트 목록을 표시합니다.
54+
시스템에서 현재 활성화된 모든 에이전트 목록을 표시합니다.

0 commit comments

Comments
 (0)