Skip to content

Commit 4b4cc96

Browse files
committed
revert: undo #6575 squash merge to restore stacked PR structure
This reverts commit d3ca954. #6575 was merged with base=main because `gt track --parent main` on a locally untracked branch caused Graphite to record main as its parent. The subsequent `gt submit --publish --force` pushed this base change to GitHub, and the PR was then squash merged, collapsing 29 commits from 6 stacked PRs into a single commit on main: - #6570 docs(FR-2532): share_vfolder labels - #6571 docs(FR-2533): user_settings - #6572 docs(FR-2534): 2FA/TOTP/SSO login - #6573 docs(FR-2535): header session timer & menu - #6574 docs(FR-2536): Start From URL & announcement banner - #6575 docs(FR-2537): dashboard board customization & auto-refresh Reverting so each PR can be merged in its original stack order. After this revert merges: - #6575 will be reopened with its original base (#6574's branch) - #6625's base will be restored to #6611's branch - The other open PRs (#6570, #6571, #6572, #6573, #6574) retain their original bases and will be mergeable in stack order
1 parent d3ca954 commit 4b4cc96

44 files changed

Lines changed: 892 additions & 1688 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: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,61 +4,51 @@ 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.
78

89
![](../images/dashboard.png)
910

1011
The page is composed of several main panels:
1112

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

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

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

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

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**:
32+
- Recently Created Sessions:
3733
Lists the most recently created active sessions within the current project.
3834
Provides session details such as name, status, CPU/memory usage, environment, resource group,
3935
session type, and creation time.
4036
By default, the latest 5 active sessions are displayed.
4137

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.
38+
For super admins, additional information is available.
4739

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

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

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.
45+
- Active Sessions:
46+
Shows the total number of active sessions across current projects,
47+
categorized by session type.
5648

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.
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.
6052

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-
:::
53+
- Active Agents:
54+
Lists all currently active agents in the system.

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

Lines changed: 24 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,13 @@ 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 the user currently belongs to is selected.
14+
By default, the project that 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-
3317
<a id="notification"></a>
3418

3519
## Notification
@@ -38,14 +22,14 @@ extension and it has been enabled in the system configuration.
3822
The bell shape button is the event notification button.
3923
Events that need to be recorded during WebUI operation are displayed here.
4024
When background tasks are running, such as creating a compute session,
41-
you can check the jobs here.
25+
you can check the jobs here. When the background task is finished.
4226
Press the shortcut key (`]`) to open and close the notification area.
4327

4428
![](../images/notification_collapse.png)
4529

4630
<a id="theme-mode"></a>
4731

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

5034

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

6044

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

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-
7448
<a id="user-menu"></a>
7549

7650
## User Menu
7751

7852

79-
Click the user icon on the right side of the top bar to see the user menu.
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.
8055

8156
![](../images/user_drop_down.png)
8257

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,
58+
- About Backend.AI: Displays information such as version of Backend.AI WebUI,
9359
license type, etc.
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.
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.
10166

10267
<a id="my-account"></a>
10368

10469
### My Account
10570

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

10873
![](../images/my_account_information.png)
10974

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

113-
- **Full Name**: User's name (up to 64 characters).
114-
- **Original password**: Original password. Click the right view button to see the
78+
- Full Name: User's name (up to 64 characters).
79+
- Original password: Original password. Click the right view button to see the
11580
input contents.
116-
- **New password**: New password (8 characters or more containing at least 1
81+
- New password: New password (8 characters or more containing at least 1
11782
alphabet, number, and symbol). Click the right view button to see the input
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.
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.
12185

12286

12387
:::note
12488
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
125-
In that case, please contact the administrator of your system.
89+
In that case, please contact administrator of your system.
12690
:::
12791

12892
<a id="2fa-setup"></a>
12993

13094
### 2FA Setup
131-
13295
If you activate the `2FA Enabled` switch, the following dialog appears.
13396

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

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

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

152115
If you want to disable 2FA, turn off the `2FA Enabled` switch and click the confirm button in the
153-
following dialog.
116+
following dialog.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.

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

Lines changed: 11 additions & 10 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 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`.
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.
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 on the Sessions page.
38+
You can see the importing operation is successfully completed in 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 on the Sessions pa
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 logged in before clicking the button. Otherwise, you have to log in first.
52+
your account must be logined before clicking the button. Otherwise, you have to login first.
5353
:::
5454

5555
![](../images/create_notebook_button.png)
@@ -59,7 +59,8 @@ Your account must be logged in before clicking the button. Otherwise, you have t
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 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
63+
FOLDER' button. If you can access to more than one storage host, you can select one from the list.
6364

6465
![](../images/import_github_repository.png)
6566

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

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

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

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

0 commit comments

Comments
 (0)