Skip to content

Commit a7033c9

Browse files
committed
docs(FR-2571): add Allowed Client IPs field to My Account dialog documentation (#6631)
Resolves #6675 (FR-2571) Documents the **Allowed client IPs** field in the My Account dialog across all supported manual languages (EN, KO, JA, TH), and adds missing login-related screenshots referenced by the login documentation. ## Changes - Added **Allowed client IPs** field documentation (CIDR examples, current-client-IP display, warning behavior) to the My Account section in all 4 languages - Restored **Original password** field documentation (conditionally shown when server does not support V2 user update API) in all four languages - Added language-specific screenshot assets `signout_button.png` and `forgot_password_panel.png` referenced from the login documentation - Fixed Thai note about V2 API availability (unified to one line, translated "user update" to Thai) **Checklist:** - [x] Documentation
1 parent 727d6fe commit a7033c9

36 files changed

Lines changed: 79 additions & 35 deletions

packages/backend.ai-webui-docs/SCREENSHOT-GUIDELINES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,12 @@ Standards for capturing, naming, and maintaining screenshots in the Backend.AI W
5151
- Avoid showing personal information, real email addresses, or API keys
5252
- Clear the browser address bar of internal/development URLs if visible
5353
- Use light theme as the default (unless documenting dark mode features)
54+
- **Always capture in English** regardless of which language directory the screenshot will be saved to. Switch the UI language to English before capturing, then copy the same screenshot to all language directories (`en/`, `ko/`, `ja/`, `th/`)
5455

5556
### Focused Cropping
5657

5758
- **Prefer element-level screenshots over full-page captures** when documenting a specific feature or interaction
59+
- **For modals and dialogs: capture only the modal element itself**, not the full page. Use the modal's DOM element as the screenshot target (e.g., `.ant-modal-wrap .ant-modal`, `[role="dialog"]`)
5860
- Use `ref` parameter in `browser_take_screenshot` to capture only the relevant element (e.g., a modal, a toolbar section, a specific panel)
5961
- Full-page captures are appropriate for page overview screenshots, but for feature-specific documentation, crop to the relevant area so users can clearly identify what is being described
6062
- Include just enough surrounding context for users to orient themselves

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

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -103,25 +103,35 @@ Below the user information, the following action items are available.
103103

104104
### My Account
105105

106-
If you click `My Account`, the following dialog appears.
106+
If you click `My Account`, the My Account Information dialog appears.
107107

108108
![](../images/my_account_information.png)
109109

110-
Each item has the following meaning. Enter the desired value and click the `Update` button to update the user
111-
information.
110+
Each item has the following meaning. Enter the desired value and click the
111+
`Update` button to update your information.
112112

113113
- **Full Name**: User's name (up to 64 characters).
114-
- **Original password**: Original password. Click the right view button to see the
115-
input contents.
114+
- **Original password**: Your current password. This field is shown only when
115+
the server does not support the V2 user update API, and you must enter it
116+
when setting a new password on such servers.
116117
- **New password**: New password (8 characters or more containing at least 1
117-
alphabet, number, and symbol). Click the right view button to see the input
118-
contents.
118+
alphabet, number, and symbol). Click the eye icon to reveal the input.
119119
- **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.
120+
- **Allowed client IPs**: Restrict login access to specific IP addresses or CIDR
121+
ranges. Enter one or more IP addresses or CIDR notations (e.g.,
122+
`10.20.30.40`, `10.20.30.0/24`). Below the field, your current client IP
123+
address is displayed with a copy button for convenience. If the configured
124+
list does not include your current IP, a warning is shown.
125+
- **2FA Enabled**: Enable or disable two-factor authentication. When enabled,
126+
you must enter an OTP code at login.
121127

128+
:::note
129+
The **Allowed client IPs** field is available when the server supports the V2
130+
user update API.
131+
:::
122132

123133
:::note
124-
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
134+
Depending on the plugin settings, the `2FA Enabled` field might not be visible.
125135
In that case, please contact the administrator of your system.
126136
:::
127137

-135 KB
Loading
Binary file not shown.
-76.9 KB
Loading
-82.4 KB
Loading
-36.8 KB
Loading
-59.9 KB
Loading
-76.2 KB
Loading

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -790,8 +790,6 @@ Click the `Create Model Card` button to open the creation modal. Fill in the fol
790790
- **VFolder** (required): The storage folder containing the model files.
791791
- **Access Level**: Set to `Internal` (visible within the domain) or `Public` (visible to all).
792792

793-
![](../images/admin_model_card_modal.png)
794-
795793
#### Editing a Model Card
796794

797795
Click the edit icon in the **Controls** column to modify an existing model card. The edit modal opens with previously entered fields already filled in.

0 commit comments

Comments
 (0)