Skip to content

Commit b106e27

Browse files
committed
docs(FR-2532): fix incorrect permission labels in share_vfolder documentation (#6570)
Resolves #6676 (FR-2532) ## Summary - Fix incorrect permission label names in the share vfolder documentation across all 4 languages (EN/KO/JA/TH) - Correct label values from ambiguous descriptions to accurate UI labels: **Read-only**, **Read-write**, **Shared (Readable)**, **Shared (Writable)** - Fix inaccurate UI descriptions for the share dialog fields - Apply reviewer fixes for grammar and consistency ## Changes - `share_vfolder/share_vfolder.md` (en/ko/ja/th): corrected permission label names and share dialog field descriptions ## Test plan - [ ] Verify permission label names match the actual UI in all 4 languages - [ ] Verify share dialog field descriptions are accurate 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent 048f747 commit b106e27

24 files changed

Lines changed: 1468 additions & 814 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.

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

Lines changed: 46 additions & 19 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 (refresh 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,27 +58,38 @@ 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.
79+
Click the user icon on the right side of the top bar to see the user menu.
5480
Each menu item has the following functions.
5581

5682
![](../images/user_drop_down.png)
5783

58-
- About Backend.AI: Displays information such as version of Backend.AI WebUI,
84+
- **About Backend.AI**: Displays information such as the version of Backend.AI WebUI,
5985
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.
86+
- **My Account**: Check and update information of the current logged-in user.
87+
- **Preferences**: Go to the user settings page.
88+
- **Logs / Errors**: Go to the logs tab in the user settings page. You can check
89+
the log and error history recorded on the client side.
90+
- **Download Desktop App**: Download the stand-alone WebUI app for your platform.
91+
This option is only visible when enabled by the administrator.
92+
- **Log Out**: Log out of the WebUI.
6693

6794
<a id="my-account"></a>
6895

@@ -75,18 +102,18 @@ If you click My Account, the following dialog appears.
75102
Each item has the following meaning. Enter the desired value and click the UPDATE button to update the user
76103
information.
77104

78-
- Full Name: User's name (up to 64 characters).
79-
- Original password: Original password. Click the right view button to see the
105+
- **Full Name**: User's name (up to 64 characters).
106+
- **Original password**: Original password. Click the right view button to see the
80107
input contents.
81-
- New password: New password (8 characters or more containing at least 1
108+
- **New password**: New password (8 characters or more containing at least 1
82109
alphabet, number, and symbol). Click the right view button to see the input
83110
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.
111+
- **2FA Enabled**: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.
85112

86113

87114
:::note
88115
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
89-
In that case, please contact administrator of your system.
116+
In that case, please contact the administrator of your system.
90117
:::
91118

92119
<a id="2fa-setup"></a>
@@ -113,4 +140,4 @@ To log in, you must open the 2FA application and enter a 6-digit code in the One
113140
![](../images/remove_2fa.png)
114141

115142
If you want to disable 2FA, turn off the `2FA Enabled` switch and click the confirm button in the
116-
following dialog.
143+
following dialog.

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

Lines changed: 90 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
## Sign up
66

7-
When you launch the WebUI, log in dialog appears. If you haven't signed up
8-
yet, press the SIGN UP button.
7+
When you launch the WebUI, the login dialog appears. If you haven't signed up
8+
yet, click the `Sign up` link at the bottom of the dialog.
99

1010
![](../images/login_dialog.png)
1111

@@ -21,24 +21,43 @@ before you can log in with your account.
2121

2222
:::note
2323
Depending on the server configuration and plugin settings, signing up by
24-
anonymous user may not be allowed. In that case, please contact administrator
24+
anonymous user may not be allowed. In that case, please contact the administrator
2525
of your system.
2626
:::
2727

2828
:::note
29-
To prevent malicious users from guessing user's password, password should be longer
30-
than 8 characters with at least one alphabet(s), number(s), and special
29+
To prevent malicious users from guessing user's password, passwords must be
30+
8 or more characters with at least one alphabet(s), number(s), and special
3131
character(s).
3232
:::
3333

3434
<a id="log-in"></a>
3535

3636
## Log in
3737

38-
Enter your ID and password and press the LOGIN button. In API ENDPOINT, the URL
39-
of Backend.AI Webserver, which relays the request to the Manager, should be
40-
entered.
38+
Enter your email (or username) and password, then click the **Login** button.
4139

40+
![](../images/login_dialog.png)
41+
42+
<a id="connection-mode"></a>
43+
44+
### Connection Mode
45+
46+
If enabled by your administrator, a mode selector appears at the top of the
47+
login dialog allowing you to choose between **Session** mode and **API** mode.
48+
49+
- **Session**: The standard login mode. Enter your email/username and password
50+
to authenticate. This is the default mode for most users.
51+
- **API**: Log in using an API keypair. Enter your **API Key** and **Secret Key**
52+
instead of email and password. This mode is useful for programmatic access.
53+
54+
<a id="api-endpoint"></a>
55+
56+
### API Endpoint
57+
58+
Click the **Advanced** link to expand the endpoint configuration section. In the
59+
API Endpoint field, enter the URL of the Backend.AI Webserver that relays
60+
requests to the Manager.
4261

4362
:::note
4463
Depending on the installation and setup environment of the Webserver,
@@ -51,37 +70,84 @@ the default password hash of BSD, is used, so even the server admins cannot
5170
know the user's password.
5271
:::
5372

54-
After logging in, you can check the information of the current resource usage in
55-
the Summary tab.
73+
<a id="sso-login"></a>
74+
75+
### SSO Login (SAML / OpenID)
76+
77+
If your administrator has configured Single Sign-On (SSO), additional login
78+
buttons may appear below the standard **Login** button:
79+
80+
- **Login with SAML**: Authenticate using your organization's SAML identity
81+
provider.
82+
- **Login with [Realm Name]**: Authenticate using an OpenID Connect provider.
83+
The button label shows the realm name configured by your administrator.
84+
85+
Click the appropriate SSO button to be redirected to your organization's
86+
identity provider for authentication.
87+
88+
:::note
89+
SSO login options are only visible when enabled by your system administrator.
90+
:::
5691

57-
By clicking the icon in the upper-right corner, you will see sub menus. You
58-
can logout by selecting the Log Out menu.
92+
<a id="otp-login"></a>
93+
94+
### OTP Login (Two-Factor Authentication)
95+
96+
If two-factor authentication (2FA) is enabled for your account, an additional
97+
OTP (One-Time Password) field appears after you enter your email and password.
98+
99+
![](../images/ask_otp_when_login.png)
100+
101+
Open your authenticator application (such as Google Authenticator, 1Password,
102+
or Bitwarden) and enter the 6-digit code in the OTP field to complete login.
103+
104+
<a id="totp-setup-on-login"></a>
105+
106+
### TOTP Setup on First Login
107+
108+
If your administrator requires two-factor authentication and you have not yet
109+
set up TOTP, a setup dialog will appear automatically after your first
110+
successful login. Scan the QR code with your authenticator application or
111+
manually enter the provided key, then enter the 6-digit verification code to
112+
complete the setup.
113+
114+
After setting up TOTP, you will need to enter the OTP code on every subsequent
115+
login.
116+
117+
:::note
118+
For more details about enabling or disabling 2FA from your account settings,
119+
refer to the [2FA Setup](#2fa-setup) section in Top Bar Features.
120+
:::
121+
122+
After logging in, you can check the information of the current resource usage on
123+
the Start page.
124+
125+
By clicking the user icon in the upper-right corner, you will see the user menu.
126+
You can log out by selecting the **Log Out** menu item.
59127

60128
![](../images/signout_button.png)
61129

62130

63131
<a id="when-you-forgot-your-password"></a>
64132

65-
## When you forgot your password
133+
## When You Forgot Your Password
66134

67-
If you have forgotten your password, you can click the CHANGE PASSWORD button on
68-
the log in panel to email a link to change password. You can change your password
69-
by reading and following the instruction. Depending on the server settings, the
70-
password change feature may be disabled. In this case, contact the
71-
administrator.
135+
If you have forgotten your password, click the **Forgot password?** text and
136+
then the **Change** link on the login panel. A dialog will appear where you can
137+
enter your email address to receive a password change link. Follow the
138+
instructions in the email to reset your password.
72139

73140
![](../images/forgot_password_panel.png)
74141

75-
76142
:::note
77-
This is also a modular feature, so changing password may not be possible in
78-
some systems.
143+
Depending on the server configuration, the password change feature may not be
144+
available. In that case, contact your administrator.
79145
:::
80146

81147
:::warning
82-
If log in failure occurs more than 10 times consecutively, access
148+
If login failure occurs more than 10 times consecutively, access
83149
to the endpoint is temporarily restricted for 20 minutes for security
84-
reasons. If the access restriction continues on more than 20 minutes, please contact
150+
reasons. If the access restriction continues after 20 minutes, please contact
85151
your system administrator.
86152
:::
87153

@@ -96,4 +162,4 @@ Clicking it again will return the sidebar to its original width.
96162
You can also use the shortcut key ( `[` ) to toggle between the narrow and original sidebar widths.
97163

98164

99-
![](../images/menu_collapse.png)
165+
![](../images/menu_collapse.png)

0 commit comments

Comments
 (0)