Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/backend.ai-webui-docs/SCREENSHOT-GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,12 @@ Standards for capturing, naming, and maintaining screenshots in the Backend.AI W
- Avoid showing personal information, real email addresses, or API keys
- Clear the browser address bar of internal/development URLs if visible
- Use light theme as the default (unless documenting dark mode features)
- **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/`)

### Focused Cropping

- **Prefer element-level screenshots over full-page captures** when documenting a specific feature or interaction
- **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"]`)
- Use `ref` parameter in `browser_take_screenshot` to capture only the relevant element (e.g., a modal, a toolbar section, a specific panel)
- 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
- Include just enough surrounding context for users to orient themselves
Expand Down
28 changes: 19 additions & 9 deletions packages/backend.ai-webui-docs/src/en/header/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,25 +103,35 @@ Below the user information, the following action items are available.

### My Account

If you click `My Account`, the following dialog appears.
If you click `My Account`, the My Account Information dialog appears.

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

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

- **Full Name**: User's name (up to 64 characters).
Comment thread
nowgnuesLee marked this conversation as resolved.
- **Original password**: Original password. Click the right view button to see the
input contents.
- **Original password**: Your current password. This field is shown only when
the server does not support the V2 user update API, and you must enter it
when setting a new password on such servers.
- **New password**: New password (8 characters or more containing at least 1
alphabet, number, and symbol). Click the right view button to see the input
contents.
alphabet, number, and symbol). Click the eye icon to reveal the input.
- **New password (again)**: Re-enter the new password for confirmation.
- **2FA Enabled**: 2FA activation. The user needs to enter the OTP code when logging in if it is checked.
- **Allowed client IPs**: Restrict login access to specific IP addresses or CIDR
ranges. Enter one or more IP addresses or CIDR notations (e.g.,
`10.20.30.40`, `10.20.30.0/24`). Below the field, your current client IP
address is displayed with a copy button for convenience. If the configured
list does not include your current IP, a warning is shown.
- **2FA Enabled**: Enable or disable two-factor authentication. When enabled,
you must enter an OTP code at login.

:::note
The **Allowed client IPs** field is available when the server supports the V2
user update API.
:::

:::note
Depending on the plugin settings, the `2FA Enabled` column might be invisible.
Depending on the plugin settings, the `2FA Enabled` field might not be visible.
In that case, please contact the administrator of your system.
:::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/en/images/menu_collapse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/en/images/signout_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/en/images/signup_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -790,8 +790,6 @@ Click the `Create Model Card` button to open the creation modal. Fill in the fol
- **VFolder** (required): The storage folder containing the model files.
- **Access Level**: Set to `Internal` (visible within the domain) or `Public` (visible to all).

![](../images/admin_model_card_modal.png)

#### Editing a Model Card

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.
Expand Down
28 changes: 21 additions & 7 deletions packages/backend.ai-webui-docs/src/ja/header/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,35 @@

### ユーザー情報の変更

`ユーザー情報の変更`をクリックすると、次のダイアログが表示されます
`ユーザー情報の変更`をクリックすると、ユーザー情報の変更ダイアログが表示されます

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

各項目には以下の意味があります。希望する値を入力し、更新ボタンをクリックしてユーザー情報を更新します。
各項目には以下の意味があります。希望する値を入力し、更新ボタンをクリックして
ユーザー情報を更新します。

- **フルネーム**: ユーザーの名前(最大64文字)。
- **現在のパスワード**: 現在のパスワード。右側の表示ボタンをクリックすると入力内容を確認できます。
- **新しいパスワード**: 新しいパスワード(英字、数字、記号をそれぞれ1つ以上含む8文字以上)。右側の表示ボタンをクリックすると入力内容を確認できます。
- **新しいパスワードを再入力)**: 確認のため新しいパスワードを再入力します。
- **2FA有効**: 二要素認証(2FA)の有効化。チェックされている場合、ユーザーはログイン時にOTPコードを入力する必要があります。
- **元のパスワード**: 現在のパスワードです。このフィールドはサーバーがV2ユーザー
更新APIをサポートしない場合にのみ表示され、そのようなサーバーで新しいパスワードを
設定する際に入力が必要です。
- **新しいパスワード**: 新しいパスワード(英字、数字、記号をそれぞれ1つ以上含む
8文字以上)。目のアイコンをクリックすると入力内容を確認できます。
- **新しいパスワードを再入力)**: 確認のため、新しいパスワードを再度入力します。
- **許可されたクライアントIP**: 特定のIPアドレスまたはCIDR範囲でログインアクセスを
Comment thread
nowgnuesLee marked this conversation as resolved.
制限します。1つ以上のIPアドレスまたはCIDR表記(例:`10.20.30.40`、
`10.20.30.0/24`)を入力できます。フィールドの下には、現在のクライアントIP
アドレスがコピーボタンとともに表示されます。設定されたリストに現在のIPが
含まれていない場合、警告が表示されます。
- **二要素認証の使用**: 二要素認証(2FA)を有効または無効にします。有効にすると、
ログイン時にOTPコードの入力が必要になります。

:::note
**許可されたクライアントIP**フィールドは、サーバーがV2ユーザー更新APIをサポート
している場合に利用できます。
:::

:::note
プラグインの設定によっては、`2FA Enabled`項目が表示されない場合があります。
プラグインの設定によっては、`二要素認証の使用`項目が表示されない場合があります。
その場合は、システム管理者に連絡してください。
:::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ja/images/menu_collapse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ja/images/signout_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ja/images/signup_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -750,8 +750,6 @@ API接続に問題が発生した場合、Chatページにモデル設定を手
- **VFolder**(必須): モデルファイルを含むストレージフォルダーです。
- **Access Level**: `Internal`(ドメイン内で表示)または`Public`(すべてのユーザーに表示)に設定します。

![](../images/admin_model_card_modal.png)

#### モデルカードの編集

**Controls**列の編集アイコンをクリックして、既存のモデルカードを変更します。以前に入力したフィールドが入力された状態で編集モーダルが開きます。
Expand Down
23 changes: 18 additions & 5 deletions packages/backend.ai-webui-docs/src/ko/header/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,21 +83,34 @@

### 사용자 정보 변경

`사용자 정보 변경`을 클릭하면, 다음과 같은 다이얼로그가 나타납니다.
`사용자 정보 변경`을 클릭하면, 사용자 정보 변경 다이얼로그가 나타납니다.

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

각 항목은 다음과 같은 의미를 가집니다. 원하는 값을 입력하고 업데이트 버튼을 클릭하면 사용자 정보가 변경됩니다.
각 항목은 다음과 같은 의미를 가집니다. 원하는 값을 입력하고 업데이트 버튼을 클릭하면
사용자 정보가 변경됩니다.

- **사용자 이름**: 사용자의 이름 (최대 64자).
- **기존 비밀번호**: 원래 비밀번호. 우측 보기 버튼을 클릭하면 입력 내용을 볼 수 있습니다.
- **기존 비밀번호**: 현재 비밀번호입니다. 이 필드는 서버가 V2 사용자 업데이트 API를
지원하지 않는 경우에만 표시되며, 해당 서버에서 새 비밀번호를 설정할 때 반드시
입력해야 합니다.
- **새 비밀번호**: 새로운 비밀번호 (영문자, 숫자, 기호가 1개 이상 포함된 8글자 이상).
눈 아이콘을 클릭하면 입력 내용을 확인할 수 있습니다.
- **새 비밀번호 (재입력)**: 확인을 위해 새 비밀번호를 다시 입력합니다.
Comment thread
nowgnuesLee marked this conversation as resolved.
- **이중 인증 사용**: 이중 인증(2FA) 사용 여부. 이중 인증이 활성화되어 있으면 로그인 시 OTP 코드를 반드시 입력해야 합니다.
- **허용된 클라이언트 IP**: 특정 IP 주소 또는 CIDR 범위로 로그인 접근을 제한합니다.
하나 이상의 IP 주소 또는 CIDR 표기법(예: `10.20.30.40`, `10.20.30.0/24`)을
입력할 수 있습니다. 필드 아래에는 현재 접속 IP 주소가 복사 버튼과 함께
표시됩니다. 설정된 목록에 현재 IP가 포함되어 있지 않으면 경고가 표시됩니다.
- **이중 인증 사용**: 이중 인증(2FA)을 활성화하거나 비활성화합니다. 활성화된 경우
로그인 시 OTP 코드를 입력해야 합니다.

:::note
**허용된 클라이언트 IP** 필드는 서버가 V2 사용자 업데이트 API를 지원하는 경우에
사용할 수 있습니다.
:::

:::note
플러그인 설정에 따라 `2FA Enabled` 항목이 표시되지 않을 수 있습니다.
플러그인 설정에 따라 `이중 인증 사용` 항목이 표시되지 않을 수 있습니다.
이 경우 시스템 관리자에게 문의하시기 바랍니다.
:::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ko/images/menu_collapse.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ko/images/signout_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/ko/images/signup_dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -767,8 +767,6 @@ API 연결에 문제가 발생하면, Chat 페이지에 모델 설정을 수동
- **VFolder** (필수): 모델 파일이 포함된 스토리지 폴더입니다.
- **Access Level**: `Internal`(도메인 내에서 표시) 또는 `Public`(모두에게 표시)으로 설정합니다.

![](../images/admin_model_card_modal.png)

#### 모델 카드 수정

**Controls** 열의 편집 아이콘을 클릭하여 기존 모델 카드를 수정합니다. 이전에 입력한 필드가 채워진 상태로 편집 모달이 열립니다.
Expand Down
25 changes: 19 additions & 6 deletions packages/backend.ai-webui-docs/src/th/header/header.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,21 +84,34 @@

### บัญชีของฉัน

หากคุณคลิก `บัญชีของฉัน` กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น
หากคุณคลิก `บัญชีของฉัน` กล่องโต้ตอบข้อมูลบัญชีของฉันจะปรากฏขึ้น

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

แต่ละรายการมีความหมายดังต่อไปนี้ ป้อนค่าที่ต้องการและคลิกปุ่ม `อัปเดต` เพื่ออัปเดตข้อมูลผู้ใช้
แต่ละรายการมีความหมายดังต่อไปนี้ ป้อนค่าที่ต้องการและคลิกปุ่ม `อัปเดต`
เพื่ออัปเดตข้อมูลผู้ใช้

- **ชื่อเต็ม**: ชื่อผู้ใช้ (สูงสุด 64 ตัวอักษร)
- **รหัสผ่านเดิม**: รหัสผ่านเดิม คลิกปุ่มดูทางด้านขวาเพื่อดูเนื้อหาที่ป้อน
- **รหัสผ่านใหม่**: รหัสผ่านใหม่ (8 ตัวอักษรขึ้นไปที่มีตัวอักษร ตัวเลข และสัญลักษณ์อย่างน้อย 1 ตัว) คลิกปุ่มดูทางด้านขวาเพื่อดูเนื้อหาที่ป้อน
- **รหัสผ่านเดิม**: รหัสผ่านปัจจุบันของคุณ ฟิลด์นี้จะแสดงเฉพาะเมื่อเซิร์ฟเวอร์ไม่รองรับ
V2 API สำหรับอัปเดตข้อมูลผู้ใช้ และคุณต้องป้อนรหัสผ่านนี้เมื่อตั้งรหัสผ่านใหม่
บนเซิร์ฟเวอร์ดังกล่าว
- **รหัสผ่านใหม่**: รหัสผ่านใหม่ (8 ตัวอักษรขึ้นไปที่มีตัวอักษร ตัวเลข
และสัญลักษณ์อย่างน้อย 1 ตัว) คลิกไอคอนรูปตาเพื่อแสดงเนื้อหาที่ป้อน
- **รหัสผ่านใหม่ (อีกครั้ง)**: ป้อนรหัสผ่านใหม่อีกครั้งเพื่อยืนยัน
- **เปิดใช้งาน 2FA**: การเปิดใช้งาน 2FA ผู้ใช้จำเป็นต้องป้อนรหัส OTP เมื่อเข้าสู่ระบบหากเปิดใช้งาน
- **IP ไคลเอนต์ที่อนุญาต**: จำกัดการเข้าถึงการเข้าสู่ระบบเฉพาะที่อยู่ IP
หรือช่วง CIDR ที่กำหนด ป้อนที่อยู่ IP หรือสัญกรณ์ CIDR หนึ่งรายการขึ้นไป
Comment thread
nowgnuesLee marked this conversation as resolved.
(เช่น `10.20.30.40`, `10.20.30.0/24`) ด้านล่างฟิลด์จะแสดง IP ไคลเอนต์
ปัจจุบันของคุณพร้อมปุ่มคัดลอกเพื่อความสะดวก หากรายการที่กำหนดไม่รวม IP
ปัจจุบันของคุณ จะแสดงคำเตือน
- **เปิดใช้งาน 2FA แล้ว**: เปิดหรือปิดใช้งานการยืนยันตัวตนสองขั้นตอน
เมื่อเปิดใช้งาน คุณต้องป้อนรหัส OTP เมื่อเข้าสู่ระบบ

:::note
ฟิลด์ **IP ไคลเอนต์ที่อนุญาต** จะใช้ได้เมื่อเซิร์ฟเวอร์สนับสนุน V2 API สำหรับอัปเดตข้อมูลผู้ใช้
:::

:::note
ขึ้นอยู่กับการตั้งค่าปลั๊กอิน คอลัมน์ `2FA Enabled` อาจไม่แสดง
ขึ้นอยู่กับการตั้งค่าปลั๊กอิน ฟิลด์ `เปิดใช้งาน 2FA แล้ว` อาจไม่แสดง
ในกรณีนี้โปรดติดต่อผู้ดูแลระบบ
:::

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified packages/backend.ai-webui-docs/src/th/images/signout_button.png
Binary file modified packages/backend.ai-webui-docs/src/th/images/signup_dialog.png
Original file line number Diff line number Diff line change
Expand Up @@ -749,8 +749,6 @@ endpoint ได้ หากบริการถูกสร้างในเ
- **VFolder** (จำเป็น): โฟลเดอร์จัดเก็บที่มีไฟล์โมเดล
- **Access Level**: ตั้งเป็น `Internal` (มองเห็นได้ภายในโดเมน) หรือ `Public` (มองเห็นได้สำหรับทุกคน)

![](../images/admin_model_card_modal.png)

#### การแก้ไขการ์ดโมเดล

คลิกไอคอนแก้ไขในคอลัมน์ **Controls** เพื่อแก้ไขการ์ดโมเดลที่มีอยู่ โมดอลแก้ไขจะเปิดขึ้นพร้อมฟิลด์ที่ป้อนไว้ก่อนหน้านี้
Expand Down
Loading