From 14ce31ce084fec829515a34fcc82af5714e982ed Mon Sep 17 00:00:00 2001 From: nowgnuesLee <192685612+nowgnuesLee@users.noreply.github.com> Date: Fri, 17 Apr 2026 10:11:18 +0000 Subject: [PATCH] docs(FR-2535): update header docs with session timer and menu corrections (#6573) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Resolves #6679 (FR-2535) ## Summary - Add **session timer** documentation showing remaining session time in the header - Correct menu item descriptions in the user dropdown (user info, preferences, logs, etc.) - Document all items visible in the user dropdown menu including "About Backend.AI", "My Account", "Preferences", "Logs / Errors", and "Download Desktop App" - Apply reviewer fixes ## Changes - `header/header.md` (en/ko/ja/th): session timer section, corrected user dropdown menu item descriptions ## Test plan - [ ] Verify session timer display matches the actual header UI - [ ] Verify all dropdown menu items are listed accurately 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- .../src/en/header/header.md | 34 ++++++++++++------- .../src/ja/header/header.md | 29 ++++++++++------ .../src/ko/header/header.md | 29 ++++++++++------ .../src/th/header/header.md | 31 +++++++++++------ 4 files changed, 80 insertions(+), 43 deletions(-) diff --git a/packages/backend.ai-webui-docs/src/en/header/header.md b/packages/backend.ai-webui-docs/src/en/header/header.md index e1643f69f5..b7f0448417 100644 --- a/packages/backend.ai-webui-docs/src/en/header/header.md +++ b/packages/backend.ai-webui-docs/src/en/header/header.md @@ -22,7 +22,7 @@ When login session management is enabled, the top bar displays the remaining time until automatic logout along with an extend button. The timer shows the time in `HH:mm:ss` format (or includes a day count if longer than 24 hours). -Click the extend button (refresh icon) next to the timer to reset the session +Click the extend button (repeat icon) next to the timer to reset the session expiration and extend your login session. :::note @@ -77,29 +77,37 @@ small screens. Click the user icon on the right side of the top bar to see the user menu. -Each menu item has the following functions. ![](../images/user_drop_down.png) -- **About Backend.AI**: Displays information such as the version of Backend.AI WebUI, +At the top of the dropdown, the following user information is displayed for +reference. These items are not clickable. + +- **Full name**: The current user's full name. +- **Email**: The current user's email address. +- **Role**: The current user's role (e.g., user, domain admin, superadmin). + +Below the user information, the following action items are available. + +- `About Backend.AI`: Displays information such as the version of Backend.AI WebUI, license type, etc. -- **My Account**: Check and update information of the current logged-in user. -- **Preferences**: Go to the user settings page. -- **Logs / Errors**: Go to the logs tab in the user settings page. You can check +- `My Account`: Check and update information of the current logged-in user. +- `Preferences`: Go to the user settings page. +- `Logs / Errors`: Go to the logs tab in the user settings page. You can check the log and error history recorded on the client side. -- **Download Desktop App**: Download the stand-alone WebUI app for your platform. +- `Download Desktop App`: Download the stand-alone WebUI app for your platform. This option is only visible when enabled by the administrator. -- **Log Out**: Log out of the WebUI. +- `Log Out`: Log out of the WebUI. ### My Account -If you click My Account, the following dialog appears. +If you click `My Account`, the following 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 +Each item has the following meaning. Enter the desired value and click the `Update` button to update the user information. - **Full Name**: User's name (up to 64 characters). @@ -107,7 +115,8 @@ information. input contents. - **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. Ensure this is the same as the Original password. + contents. +- **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. @@ -119,6 +128,7 @@ In that case, please contact the administrator of your system. ### 2FA Setup + If you activate the `2FA Enabled` switch, the following dialog appears. ![](../images/2fa_setup.png) @@ -128,7 +138,7 @@ code. There are many 2FA-enabled applications, such as Google Authenticator, 2ST and Bitwarden. Then enter the 6-digit code from the item added to your 2FA application into the dialog above. -2FA is activated when you press the CONFIRM button. +2FA is activated when you press the `OK` button. When you log in later, if you enter an email and password, an additional field appears asking for the OTP code. diff --git a/packages/backend.ai-webui-docs/src/ja/header/header.md b/packages/backend.ai-webui-docs/src/ja/header/header.md index 47aa12cb5b..e89e01ba75 100644 --- a/packages/backend.ai-webui-docs/src/ja/header/header.md +++ b/packages/backend.ai-webui-docs/src/ja/header/header.md @@ -18,7 +18,7 @@ ログインセッション管理が有効な場合、トップバーに自動ログアウトまでの残り時間と延長ボタンが表示されます。タイマーは`HH:mm:ss`形式で表示され、24時間以上の場合は日数も併せて表示されます。 -タイマーの横にある延長ボタン（更新アイコン）をクリックすると、セッションの有効期限がリセットされ、ログインセッションが延長されます。 +タイマーの横にある延長ボタン（リピートアイコン）をクリックすると、セッションの有効期限がリセットされ、ログインセッションが延長されます。 :::note ログインセッションタイマーは、サーバーがログインセッション延長をサポートし、システム設定で有効化されている場合のみ表示されます。 @@ -61,22 +61,30 @@ ## ユーザーメニュー -トップバーの右側にあるユーザーアイコンをクリックすると、ユーザーメニューが表示されます。各メニュー項目には以下の機能があります。 +トップバーの右側にあるユーザーアイコンをクリックすると、ユーザーメニューが表示されます。 ![](../images/user_drop_down.png) -- **Backend.AIについて**: Backend.AI WebUIのバージョン、ライセンスの種類などの情報を表示します。 -- **ユーザー情報の変更**: 現在ログインしているユーザーの情報を確認・更新します。 -- **環境設定**: ユーザー設定ページへ移動します。 -- **ログ/エラー**: ユーザー設定ページのログタブに移動します。クライアント側に記録されたログとエラーの履歴を確認できます。 -- **デスクトップアプリをダウンロード**: 使用プラットフォーム向けのスタンドアロンWebUIアプリをダウンロードします。このオプションは管理者が有効にした場合のみ表示されます。 -- **ログアウト**: WebUIからログアウトします。 +ドロップダウンの上部には、以下のユーザー情報が表示されます。これらの項目はクリックできない参考情報です。 + +- **フルネーム**: 現在のユーザーのフルネーム。 +- **メール**: 現在のユーザーのメールアドレス。 +- **ロール**: 現在のユーザーのロール（例: ユーザー、ドメイン管理者、スーパー管理者）。 + +ユーザー情報の下には、以下のアクション項目があります。 + +- `Backend.AIについて`: Backend.AI WebUIのバージョン、ライセンスの種類などの情報を表示します。 +- `ユーザー情報の変更`: 現在ログインしているユーザーの情報を確認・更新します。 +- `環境設定`: ユーザー設定ページへ移動します。 +- `ログ/エラー`: ユーザー設定ページのログタブに移動します。クライアント側に記録されたログとエラーの履歴を確認できます。 +- `デスクトップアプリをダウンロード`: 使用プラットフォーム向けのスタンドアロンWebUIアプリをダウンロードします。このオプションは管理者が有効にした場合のみ表示されます。 +- `ログアウト`: WebUIからログアウトします。 ### ユーザー情報の変更 -ユーザー情報の変更をクリックすると、次のダイアログが表示されます。 +`ユーザー情報の変更`をクリックすると、次のダイアログが表示されます。 ![](../images/my_account_information.png) @@ -85,6 +93,7 @@ - **フルネーム**: ユーザーの名前（最大64文字）。 - **現在のパスワード**: 現在のパスワード。右側の表示ボタンをクリックすると入力内容を確認できます。 - **新しいパスワード**: 新しいパスワード（英字、数字、記号をそれぞれ1つ以上含む8文字以上）。右側の表示ボタンをクリックすると入力内容を確認できます。 +- **新しいパスワードを再入力）**: 確認のため新しいパスワードを再入力します。 - **2FA有効**: 二要素認証(2FA)の有効化。チェックされている場合、ユーザーはログイン時にOTPコードを入力する必要があります。 @@ -103,7 +112,7 @@ 使用している2FAアプリケーションを起動し、QRコードをスキャンするか、手動で検証コードを入力します。2FA対応のアプリケーションには、Google Authenticator、2STP、1Password、Bitwardenなどがあります。 -2FAアプリケーションに追加された項目から6桁のコードを上記のダイアログに入力します。確認ボタンを押すと、2FAが有効になります。 +2FAアプリケーションに追加された項目から6桁のコードを上記のダイアログに入力します。`確認`ボタンを押すと、2FAが有効になります。 後でログインする際に、メールアドレスとパスワードを入力すると、OTPコードを求める追加フィールドが表示されます。 diff --git a/packages/backend.ai-webui-docs/src/ko/header/header.md b/packages/backend.ai-webui-docs/src/ko/header/header.md index 44023a2218..99541f953f 100644 --- a/packages/backend.ai-webui-docs/src/ko/header/header.md +++ b/packages/backend.ai-webui-docs/src/ko/header/header.md @@ -18,7 +18,7 @@ 로그인 세션 관리가 활성화된 경우, 상단 바에 자동 로그아웃까지 남은 시간과 연장 버튼이 표시됩니다. 타이머는 `HH:mm:ss` 형식으로 표시되며, 24시간 이상인 경우 일수도 함께 표시됩니다. -타이머 옆의 연장 버튼(새로고침 아이콘)을 클릭하면 세션 만료 시간이 초기화되어 로그인 세션이 연장됩니다. +타이머 옆의 연장 버튼(반복 아이콘)을 클릭하면 세션 만료 시간이 초기화되어 로그인 세션이 연장됩니다. :::note 로그인 세션 타이머는 서버가 로그인 세션 연장을 지원하고 시스템 설정에서 활성화된 경우에만 표시됩니다. @@ -60,22 +60,30 @@ ## 사용자 메뉴 -상단 바 우측의 사용자 아이콘 버튼을 클릭하여 사용자 메뉴를 확인할 수 있습니다. 각 항목은 다음과 같은 기능을 가집니다. +상단 바 우측의 사용자 아이콘 버튼을 클릭하여 사용자 메뉴를 확인할 수 있습니다. ![](../images/user_drop_down.png) -- **Backend.AI에 대하여**: Backend.AI WebUI의 버전, 라이선스 종류 등과 같은 정보를 표시합니다. -- **사용자 정보 변경**: 현재 로그인된 사용자 정보를 확인하거나 변경합니다. -- **설정**: 사용자 설정 페이지로 이동합니다. -- **로그 / 에러기록**: 사용자 설정 페이지의 로그 탭으로 이동합니다. 클라이언트 측에 기록된 로그 및 오류 내역을 확인할 수 있습니다. -- **데스크톱 앱 다운로드**: 사용자의 플랫폼에 맞는 독립형 WebUI 앱을 다운로드합니다. 이 옵션은 관리자가 활성화한 경우에만 표시됩니다. -- **로그아웃**: WebUI에서 로그아웃합니다. +드롭다운 상단에는 다음과 같은 사용자 정보가 표시됩니다. 이 항목들은 클릭할 수 없는 참고 정보입니다. + +- **이름**: 현재 사용자의 전체 이름. +- **이메일**: 현재 사용자의 이메일 주소. +- **역할**: 현재 사용자의 역할 (예: 사용자, 도메인 관리자, 슈퍼관리자). + +사용자 정보 아래에는 다음과 같은 실행 항목이 있습니다. + +- `Backend.AI에 대하여`: Backend.AI WebUI의 버전, 라이선스 종류 등과 같은 정보를 표시합니다. +- `사용자 정보 변경`: 현재 로그인된 사용자 정보를 확인하거나 변경합니다. +- `설정`: 사용자 설정 페이지로 이동합니다. +- `로그 / 에러기록`: 사용자 설정 페이지의 로그 탭으로 이동합니다. 클라이언트 측에 기록된 로그 및 오류 내역을 확인할 수 있습니다. +- `데스크톱 앱 다운로드`: 사용자의 플랫폼에 맞는 독립형 WebUI 앱을 다운로드합니다. 이 옵션은 관리자가 활성화한 경우에만 표시됩니다. +- `로그아웃`: WebUI에서 로그아웃합니다. ### 사용자 정보 변경 -사용자 정보 변경을 클릭하면, 다음과 같은 다이얼로그가 나타납니다. +`사용자 정보 변경`을 클릭하면, 다음과 같은 다이얼로그가 나타납니다. ![](../images/my_account_information.png) @@ -84,6 +92,7 @@ - **사용자 이름**: 사용자의 이름 (최대 64자). - **기존 비밀번호**: 원래 비밀번호. 우측 보기 버튼을 클릭하면 입력 내용을 볼 수 있습니다. - **새 비밀번호**: 새로운 비밀번호 (영문자, 숫자, 기호가 1개 이상 포함된 8글자 이상). +- **새 비밀번호 (재입력)**: 확인을 위해 새 비밀번호를 다시 입력합니다. - **이중 인증 사용**: 이중 인증(2FA) 사용 여부. 이중 인증이 활성화되어 있으면 로그인 시 OTP 코드를 반드시 입력해야 합니다. @@ -102,7 +111,7 @@ 사용자가 사용하는 이중 인증 애플리케이션을 켜고 QR 코드를 스캔하거나 인증 코드를 직접 입력합니다. 이중 인증 지원 애플리케이션은 Google Authenticator, 2STP, 1Password, Bitwarden 등이 있습니다. -이중 인증 애플리케이션에 추가된 항목의 6자리 코드를 위 다이얼로그에 입력합니다. 확인 버튼을 누르면 이중 인증 활성화가 완료됩니다. +이중 인증 애플리케이션에 추가된 항목의 6자리 코드를 위 다이얼로그에 입력합니다. `확인` 버튼을 누르면 이중 인증 활성화가 완료됩니다. 이후 해당 사용자의 로그인 과정에서 OTP 코드를 묻는 추가 필드가 나타납니다. diff --git a/packages/backend.ai-webui-docs/src/th/header/header.md b/packages/backend.ai-webui-docs/src/th/header/header.md index 5d28892f7a..f2d9fa3756 100644 --- a/packages/backend.ai-webui-docs/src/th/header/header.md +++ b/packages/backend.ai-webui-docs/src/th/header/header.md @@ -18,7 +18,7 @@ เมื่อเปิดใช้งานการจัดการเซสชันการเข้าสู่ระบบ แถบด้านบนจะแสดงเวลาที่เหลือจนกระทั่งออกจากระบบอัตโนมัติพร้อมกับปุ่มขยายเวลา ตัวจับเวลาจะแสดงเวลาในรูปแบบ `HH:mm:ss` (หรือรวมจำนวนวันหากนานกว่า 24 ชั่วโมง) -คลิกปุ่มขยายเวลา (ไอคอนรีเฟรช) ข้างตัวจับเวลาเพื่อรีเซ็ตเวลาหมดอายุของเซสชันและขยายเวลาเซสชันการเข้าสู่ระบบ +คลิกปุ่มขยายเวลา (ไอคอนรีพีท) ข้างตัวจับเวลาเพื่อรีเซ็ตเวลาหมดอายุของเซสชันและขยายเวลาเซสชันการเข้าสู่ระบบ :::note ตัวจับเวลาเซสชันการเข้าสู่ระบบจะแสดงเฉพาะเมื่อเซิร์ฟเวอร์สนับสนุนการขยายเวลาเซสชันการเข้าสู่ระบบและเปิดใช้งานในการตั้งค่าระบบ @@ -61,30 +61,39 @@ ## เมนูผู้ใช้ -คลิกไอคอนผู้ใช้ที่ด้านขวาของแถบด้านบนเพื่อดูเมนูผู้ใช้ แต่ละรายการเมนูมีฟังก์ชันดังต่อไปนี้ +คลิกไอคอนผู้ใช้ที่ด้านขวาของแถบด้านบนเพื่อดูเมนูผู้ใช้ ![](../images/user_drop_down.png) -- **เกี่ยวกับ Backend.AI**: แสดงข้อมูลเช่น เวอร์ชันของ Backend.AI WebUI ประเภทใบอนุญาต เป็นต้น -- **บัญชีของฉัน**: ตรวจสอบและอัปเดตข้อมูลของผู้ใช้ที่เข้าสู่ระบบอยู่ -- **การตั้งค่าส่วนตัว**: ไปที่หน้าการตั้งค่าผู้ใช้ -- **บันทึก / ข้อผิดพลาด**: ไปที่แท็บบันทึกในหน้าการตั้งค่าผู้ใช้ คุณสามารถตรวจสอบประวัติบันทึกและข้อผิดพลาดที่บันทึกไว้ฝั่งไคลเอนต์ได้ -- **ดาวน์โหลดแอพเดสก์ท็อป**: ดาวน์โหลดแอป WebUI แบบสแตนด์อะโลนสำหรับแพลตฟอร์มของคุณ ตัวเลือกนี้แสดงเฉพาะเมื่อผู้ดูแลระบบเปิดใช้งาน -- **ออกจากระบบ**: ออกจากระบบ WebUI +ที่ด้านบนของดรอปดาวน์จะแสดงข้อมูลผู้ใช้ดังต่อไปนี้เพื่อเป็นข้อมูลอ้างอิง รายการเหล่านี้ไม่สามารถคลิกได้ + +- **ชื่อเต็ม**: ชื่อเต็มของผู้ใช้ปัจจุบัน +- **อีเมล**: ที่อยู่อีเมลของผู้ใช้ปัจจุบัน +- **บทบาท**: บทบาทของผู้ใช้ปัจจุบัน (เช่น ผู้ใช้, ผู้ดูแลโดเมน, ซุปเปอร์แอดมิน) + +ด้านล่างข้อมูลผู้ใช้มีรายการการดำเนินการดังต่อไปนี้ + +- `เกี่ยวกับ Backend.AI`: แสดงข้อมูลเช่น เวอร์ชันของ Backend.AI WebUI ประเภทใบอนุญาต เป็นต้น +- `บัญชีของฉัน`: ตรวจสอบและอัปเดตข้อมูลของผู้ใช้ที่เข้าสู่ระบบอยู่ +- `การตั้งค่าส่วนตัว`: ไปที่หน้าการตั้งค่าผู้ใช้ +- `บันทึก / ข้อผิดพลาด`: ไปที่แท็บบันทึกในหน้าการตั้งค่าผู้ใช้ คุณสามารถตรวจสอบประวัติบันทึกและข้อผิดพลาดที่บันทึกไว้ฝั่งไคลเอนต์ได้ +- `ดาวน์โหลดแอพเดสก์ท็อป`: ดาวน์โหลดแอป WebUI แบบสแตนด์อะโลนสำหรับแพลตฟอร์มของคุณ ตัวเลือกนี้แสดงเฉพาะเมื่อผู้ดูแลระบบเปิดใช้งาน +- `ออกจากระบบ`: ออกจากระบบ WebUI ### บัญชีของฉัน -หากคุณคลิกบัญชีของฉัน กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น +หากคุณคลิก `บัญชีของฉัน` กล่องโต้ตอบต่อไปนี้จะปรากฏขึ้น ![](../images/my_account_information.png) -แต่ละรายการมีความหมายดังต่อไปนี้ ป้อนค่าที่ต้องการและคลิกปุ่ม UPDATE เพื่ออัปเดตข้อมูลผู้ใช้ +แต่ละรายการมีความหมายดังต่อไปนี้ ป้อนค่าที่ต้องการและคลิกปุ่ม `อัปเดต` เพื่ออัปเดตข้อมูลผู้ใช้ - **ชื่อเต็ม**: ชื่อผู้ใช้ (สูงสุด 64 ตัวอักษร) - **รหัสผ่านเดิม**: รหัสผ่านเดิม คลิกปุ่มดูทางด้านขวาเพื่อดูเนื้อหาที่ป้อน - **รหัสผ่านใหม่**: รหัสผ่านใหม่ (8 ตัวอักษรขึ้นไปที่มีตัวอักษร ตัวเลข และสัญลักษณ์อย่างน้อย 1 ตัว) คลิกปุ่มดูทางด้านขวาเพื่อดูเนื้อหาที่ป้อน +- **รหัสผ่านใหม่ (อีกครั้ง)**: ป้อนรหัสผ่านใหม่อีกครั้งเพื่อยืนยัน - **เปิดใช้งาน 2FA**: การเปิดใช้งาน 2FA ผู้ใช้จำเป็นต้องป้อนรหัส OTP เมื่อเข้าสู่ระบบหากเปิดใช้งาน @@ -103,7 +112,7 @@ เปิดแอปพลิเคชัน 2FA ที่คุณใช้และสแกนรหัส QR หรือป้อนรหัสยืนยันด้วยตนเอง มีแอปพลิเคชันที่รองรับ 2FA หลายตัว เช่น Google Authenticator, 2STP, 1Password และ Bitwarden -จากนั้นให้ป้อนรหัส 6 หลักจากรายการที่เพิ่มไปยังแอปพลิเคชัน 2FA ของคุณในกล่องโต้ตอบด้านบน 2FA จะถูกเปิดใช้งานเมื่อคุณกดปุ่มยืนยัน +จากนั้นให้ป้อนรหัส 6 หลักจากรายการที่เพิ่มไปยังแอปพลิเคชัน 2FA ของคุณในกล่องโต้ตอบด้านบน 2FA จะถูกเปิดใช้งานเมื่อคุณกดปุ่ม `ยืนยัน` เมื่อคุณเข้าสู่ระบบในภายหลัง หากคุณใส่อีเมลและรหัสผ่าน จะมีฟิลด์เพิ่มเติมปรากฏขึ้นเพื่อขอรหัส OTP