Skip to content

Commit d3ca954

Browse files
committed
docs(FR-2537): add board customization and auto-refresh to dashboard docs (#6575)
Resolves #6681 (FR-2537) ## Summary - Document **board customization** via drag-and-drop on the Dashboard page - Document the **auto-refresh** toggle and configurable refresh interval - Correct admin dashboard panel descriptions (Active Sessions, Resource Slots, etc.) and their actual refresh intervals - Apply reviewer fixes ## Changes - `dashboard/dashboard.md` (en/ko/ja/th): board customization section, auto-refresh toggle, corrected admin panel descriptions ## Test plan - [ ] Verify drag-and-drop board customization behavior is accurately described - [ ] Verify auto-refresh interval options match the actual UI - [ ] Verify admin dashboard panel names and descriptions are accurate 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent f599a07 commit d3ca954

44 files changed

Lines changed: 1688 additions & 892 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,61 @@ 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+
:::note
32+
The **Total Resources in Resource Group** panel may not be visible depending on your
33+
system configuration.
34+
:::
35+
36+
- **Recently Created Sessions**:
3337
Lists the most recently created active sessions within the current project.
3438
Provides session details such as name, status, CPU/memory usage, environment, resource group,
3539
session type, and creation time.
3640
By default, the latest 5 active sessions are displayed.
3741

38-
For super admins, additional information is available.
42+
## Auto-Refresh
43+
44+
The Dashboard automatically refreshes all panel data every **15 seconds**. This
45+
ensures that the displayed information stays up to date without requiring manual
46+
interaction.
3947

40-
![](../images/admin_dashboard.png)
48+
## Customizing the Dashboard Layout
4149

42-
Except for 'Active Sessions', 'Agent Statistics', and 'Active Agents', the remaining panels
43-
display the same information as the user dashboard.
50+
You can customize the Dashboard layout by rearranging and resizing panels to
51+
suit your preferences.
4452

45-
- Active Sessions:
46-
Shows the total number of active sessions across current projects,
47-
categorized by session type.
53+
- **Move panels**: Drag a panel by its header to reposition it on the board.
54+
- **Resize panels**: Drag the bottom-right corner of a panel to adjust its
55+
size. Each panel has a minimum size to ensure its content remains readable.
4856

49-
- Agent Statistics:
50-
Provides all used resources across all agents in the system.
51-
The values represent the total used resources by all active sessions.
57+
Your customized layout is automatically saved and persists across browser
58+
sessions. The layout is stored per user, so each user can have their own
59+
preferred arrangement.
5260

53-
- Active Agents:
54-
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/en/header/header.md

Lines changed: 61 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,29 @@ The top bar includes various features that support use of the WebUI.
77

88
<a id="project-selector"></a>
99

10-
## Project selector
10+
## Project Selector
1111

1212

1313
Users can switch between projects using the project selector provided in the top bar.
14-
By default, the project that user currently belongs to is selected.
14+
By default, the project that the user currently belongs to is selected.
1515
Since each project may have different resource policies, switching projects may also change the available resource policies.
1616

17+
<a id="login-session-timer"></a>
18+
19+
## Login Session Timer
20+
21+
When login session management is enabled, the top bar displays the remaining
22+
time until automatic logout along with an extend button. The timer shows the
23+
time in `HH:mm:ss` format (or includes a day count if longer than 24 hours).
24+
25+
Click the extend button (repeat icon) next to the timer to reset the session
26+
expiration and extend your login session.
27+
28+
:::note
29+
The login session timer is only visible when the server supports login session
30+
extension and it has been enabled in the system configuration.
31+
:::
32+
1733
<a id="notification"></a>
1834

1935
## Notification
@@ -22,14 +38,14 @@ Since each project may have different resource policies, switching projects may
2238
The bell shape button is the event notification button.
2339
Events that need to be recorded during WebUI operation are displayed here.
2440
When background tasks are running, such as creating a compute session,
25-
you can check the jobs here. When the background task is finished.
41+
you can check the jobs here.
2642
Press the shortcut key (`]`) to open and close the notification area.
2743

2844
![](../images/notification_collapse.png)
2945

3046
<a id="theme-mode"></a>
3147

32-
## Theme mode
48+
## Theme Mode
3349

3450

3551
You can change the theme mode of the WebUI via the dark mode button on the
@@ -42,56 +58,77 @@ right side of the header.
4258
## Help
4359

4460

45-
Click question mark button to access the web version of this guide document.
61+
Click the question mark button to access the web version of this guide document.
4662
You will be directed to the appropriate documentation based on the page you are currently on.
4763

64+
<a id="responsive-layout"></a>
65+
66+
## Responsive Layout
67+
68+
On smaller screens, the top bar adjusts its layout for better usability. When
69+
the screen width is narrow, the sidebar toggle is replaced with a menu icon
70+
button in the top bar. The user's display name may also be hidden, showing only
71+
the avatar icon for the user menu. The project label text is hidden on very
72+
small screens.
73+
4874
<a id="user-menu"></a>
4975

5076
## User Menu
5177

5278

53-
Click the person button on the right side of the top bar to see the user menu.
54-
Each menu item has the following functions.
79+
Click the user icon on the right side of the top bar to see the user menu.
5580

5681
![](../images/user_drop_down.png)
5782

58-
- About Backend.AI: Displays information such as version of Backend.AI WebUI,
83+
At the top of the dropdown, the following user information is displayed for
84+
reference. These items are not clickable.
85+
86+
- **Full name**: The current user's full name.
87+
- **Email**: The current user's email address.
88+
- **Role**: The current user's role (e.g., user, domain admin, superadmin).
89+
90+
Below the user information, the following action items are available.
91+
92+
- `About Backend.AI`: Displays information such as the version of Backend.AI WebUI,
5993
license type, etc.
60-
- My Account: Check / Update information of current login user.
61-
- Preferences: Go to user settings page.
62-
- Logs / Errors: Go to the log page. You can check the log and error history
63-
recorded on the client side.
64-
- Download Desktop App: Download the stand-alone WebUI app for your platform.
65-
- Log Out: Log out of the WebUI.
94+
- `My Account`: Check and update information of the current logged-in user.
95+
- `Preferences`: Go to the user settings page.
96+
- `Logs / Errors`: Go to the logs tab in the user settings page. You can check
97+
the log and error history recorded on the client side.
98+
- `Download Desktop App`: Download the stand-alone WebUI app for your platform.
99+
This option is only visible when enabled by the administrator.
100+
- `Log Out`: Log out of the WebUI.
66101

67102
<a id="my-account"></a>
68103

69104
### My Account
70105

71-
If you click My Account, the following dialog appears.
106+
If you click `My Account`, the following dialog appears.
72107

73108
![](../images/my_account_information.png)
74109

75-
Each item has the following meaning. Enter the desired value and click the UPDATE button to update the user
110+
Each item has the following meaning. Enter the desired value and click the `Update` button to update the user
76111
information.
77112

78-
- Full Name: User's name (up to 64 characters).
79-
- Original password: Original password. Click the right view button to see the
113+
- **Full Name**: User's name (up to 64 characters).
114+
- **Original password**: Original password. Click the right view button to see the
80115
input contents.
81-
- New password: New password (8 characters or more containing at least 1
116+
- **New password**: New password (8 characters or more containing at least 1
82117
alphabet, number, and symbol). Click the right view button to see the input
83-
contents. Ensure this is the same as the Original password.
84-
- 2FA Enabled: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.
118+
contents.
119+
- **New password (again)**: Re-enter the new password for confirmation.
120+
- **2FA Enabled**: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.
85121

86122

87123
:::note
88124
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
89-
In that case, please contact administrator of your system.
125+
In that case, please contact the administrator of your system.
90126
:::
91127

92128
<a id="2fa-setup"></a>
93129

94130
### 2FA Setup
131+
95132
If you activate the `2FA Enabled` switch, the following dialog appears.
96133

97134
![](../images/2fa_setup.png)
@@ -101,7 +138,7 @@ code. There are many 2FA-enabled applications, such as Google Authenticator, 2ST
101138
and Bitwarden.
102139

103140
Then enter the 6-digit code from the item added to your 2FA application into the dialog above.
104-
2FA is activated when you press the CONFIRM button.
141+
2FA is activated when you press the `OK` button.
105142

106143
When you log in later, if you enter an email and password, an additional field appears asking
107144
for the OTP code.
@@ -113,4 +150,4 @@ To log in, you must open the 2FA application and enter a 6-digit code in the One
113150
![](../images/remove_2fa.png)
114151

115152
If you want to disable 2FA, turn off the `2FA Enabled` switch and click the confirm button in the
116-
following dialog.
153+
following dialog.
281 KB
Loading
84 KB
Loading
95.5 KB
Loading
86.1 KB
Loading

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ and click the button on the right side.
88

99
<a id="import-and-run-jupyter-notebooks"></a>
1010

11-
## Import and run Jupyter notebooks
11+
## Import and Run Jupyter Notebooks
1212

1313
To import Jupyter notebooks and run, you need one thing, the valid URL for the notebook file.
1414
For example, if you want execute Jupyter notebook that's in github, you can copy and paste
15-
the URL and click 'IMPORT & RUN' button.
15+
the URL and click `Import & Run` button.
1616

1717
:::note
18-
When you trying to IMPORT & RUN Jupyter notebook file with local address,
19-
It will be regarded as invalid. You have to input URL which is not starting from localhost.
18+
When you try to import and run a Jupyter notebook file with a local address,
19+
it will be regarded as invalid. You must input a URL that does not start with `localhost`.
2020
:::
2121

2222
![](../images/import_run_notebook.png)
@@ -35,7 +35,7 @@ imported Jupyter notebook will not run.
3535

3636
![](../images/session_launcher_in_importing_notebook.png)
3737

38-
You can see the importing operation is successfully completed in Sessions page.
38+
You can see the importing operation is successfully completed on the Sessions page.
3939

4040
![](../images/sessions_page_with_imported_notebook.png)
4141

@@ -44,12 +44,12 @@ You can see the importing operation is successfully completed in Sessions page.
4444
## Create executable Jupyter notebook button
4545

4646
You can also create HTML or Markdown button about Jupyter notebook URL, too.
47-
Input a valid Jupyter notebook URL and click 'CREATE' button. It will show code blocks that directly
47+
Input a valid Jupyter notebook URL and click `Create` button. It will show code blocks that directly
4848
links to creating a session with notebook. You can see the badge code working by inserting it in
4949
the GitHub repositories or where it supports html or markdown.
5050

5151
:::note
52-
your account must be logined before clicking the button. Otherwise, you have to login first.
52+
Your account must be logged in before clicking the button. Otherwise, you have to log in first.
5353
:::
5454

5555
![](../images/create_notebook_button.png)
@@ -59,8 +59,7 @@ your account must be logined before clicking the button. Otherwise, you have to
5959
## Importing GitHub Repositories
6060

6161
Importing a GitHub repository is similar to import and running Jupyter notebook.
62-
All you have to do is to fill out with github repository URL and click 'GET TO
63-
FOLDER' button. If you can access to more than one storage host, you can select one from the list.
62+
All you have to do is to fill out with github repository URL and click `Get To Folder` button. If you can access to more than one storage host, you can select one from the list.
6463

6564
![](../images/import_github_repository.png)
6665

@@ -70,7 +69,7 @@ the limit, then importing repository will fail. Please check resource
7069
statistics panel and Data & Storage page before importing the repository.
7170
:::
7271

73-
You can see the repository is successfully imported as a data folder with its
72+
You can see the repository is successfully imported as a storage folder with its
7473
name.
7574

7675
![](../images/import_github_repository_result.png)
@@ -86,6 +85,6 @@ but you need to explicitly set the branch name to import.
8685
![](../images/import_gitlab_repository.png)
8786

8887
:::note
89-
If there's data folder that has the same name already, the system will append
88+
If there's storage folder that has the same name already, the system will append
9089
`_` (underscore) and number in the imported repository folder.
9190
:::

0 commit comments

Comments
 (0)