Skip to content

Commit 7a6f7ae

Browse files
nowgnuesLeeagatha197
authored andcommitted
docs: add user info items in dropdown menu to header docs
1 parent f8d24c9 commit 7a6f7ae

4 files changed

Lines changed: 70 additions & 38 deletions

File tree

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

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,29 +77,37 @@ small screens.
7777

7878

7979
Click the user icon on the right side of the top bar to see the user menu.
80-
Each menu item has the following functions.
8180

8281
![](../images/user_drop_down.png)
8382

84-
- **About Backend.AI**: Displays information such as the version of Backend.AI WebUI,
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,
8593
license type, etc.
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
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
8997
the log and error history recorded on the client side.
90-
- **Download Desktop App**: Download the stand-alone WebUI app for your platform.
98+
- `Download Desktop App`: Download the stand-alone WebUI app for your platform.
9199
This option is only visible when enabled by the administrator.
92-
- **Log Out**: Log out of the WebUI.
100+
- `Log Out`: Log out of the WebUI.
93101

94102
<a id="my-account"></a>
95103

96104
### My Account
97105

98-
If you click My Account, the following dialog appears.
106+
If you click `My Account`, the following dialog appears.
99107

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

102-
Each item has the following meaning. Enter the desired value and click the UPDATE button to update the user
110+
Each item has the following meaning. Enter the desired value and click the `UPDATE` button to update the user
103111
information.
104112

105113
- **Full Name**: User's name (up to 64 characters).
@@ -129,7 +137,7 @@ code. There are many 2FA-enabled applications, such as Google Authenticator, 2ST
129137
and Bitwarden.
130138

131139
Then enter the 6-digit code from the item added to your 2FA application into the dialog above.
132-
2FA is activated when you press the CONFIRM button.
140+
2FA is activated when you press the `CONFIRM` button.
133141

134142
When you log in later, if you enter an email and password, an additional field appears asking
135143
for the OTP code.

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

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,22 +61,30 @@
6161
## ユーザーメニュー
6262

6363

64-
トップバーの右側にあるユーザーアイコンをクリックすると、ユーザーメニューが表示されます。各メニュー項目には以下の機能があります。
64+
トップバーの右側にあるユーザーアイコンをクリックすると、ユーザーメニューが表示されます。
6565

6666
![](../images/user_drop_down.png)
6767

68-
- **Backend.AIについて**: Backend.AI WebUIのバージョン、ライセンスの種類などの情報を表示します。
69-
- **ユーザー情報の変更**: 現在ログインしているユーザーの情報を確認・更新します。
70-
- **環境設定**: ユーザー設定ページへ移動します。
71-
- **ログ/エラー**: ユーザー設定ページのログタブに移動します。クライアント側に記録されたログとエラーの履歴を確認できます。
72-
- **デスクトップアプリをダウンロード**: 使用プラットフォーム向けのスタンドアロンWebUIアプリをダウンロードします。このオプションは管理者が有効にした場合のみ表示されます。
73-
- **ログアウト**: WebUIからログアウトします。
68+
ドロップダウンの上部には、以下のユーザー情報が表示されます。これらの項目はクリックできない参考情報です。
69+
70+
- **フルネーム**: 現在のユーザーのフルネーム。
71+
- **メール**: 現在のユーザーのメールアドレス。
72+
- **ロール**: 現在のユーザーのロール(例: ユーザー、ドメイン管理者、スーパー管理者)。
73+
74+
ユーザー情報の下には、以下のアクション項目があります。
75+
76+
- `Backend.AIについて`: Backend.AI WebUIのバージョン、ライセンスの種類などの情報を表示します。
77+
- `ユーザー情報の変更`: 現在ログインしているユーザーの情報を確認・更新します。
78+
- `環境設定`: ユーザー設定ページへ移動します。
79+
- `ログ/エラー`: ユーザー設定ページのログタブに移動します。クライアント側に記録されたログとエラーの履歴を確認できます。
80+
- `デスクトップアプリをダウンロード`: 使用プラットフォーム向けのスタンドアロンWebUIアプリをダウンロードします。このオプションは管理者が有効にした場合のみ表示されます。
81+
- `ログアウト`: WebUIからログアウトします。
7482

7583
<a id="my-account"></a>
7684

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

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

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

@@ -103,7 +111,7 @@
103111

104112
使用している2FAアプリケーションを起動し、QRコードをスキャンするか、手動で検証コードを入力します。2FA対応のアプリケーションには、Google Authenticator、2STP、1Password、Bitwardenなどがあります。
105113

106-
2FAアプリケーションに追加された項目から6桁のコードを上記のダイアログに入力します。確認ボタンを押すと、2FAが有効になります。
114+
2FAアプリケーションに追加された項目から6桁のコードを上記のダイアログに入力します。`確認`ボタンを押すと、2FAが有効になります。
107115

108116
後でログインする際に、メールアドレスとパスワードを入力すると、OTPコードを求める追加フィールドが表示されます。
109117

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

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,22 +60,30 @@
6060
## 사용자 메뉴
6161

6262

63-
상단 바 우측의 사용자 아이콘 버튼을 클릭하여 사용자 메뉴를 확인할 수 있습니다. 각 항목은 다음과 같은 기능을 가집니다.
63+
상단 바 우측의 사용자 아이콘 버튼을 클릭하여 사용자 메뉴를 확인할 수 있습니다.
6464

6565
![](../images/user_drop_down.png)
6666

67-
- **Backend.AI에 대하여**: Backend.AI WebUI의 버전, 라이선스 종류 등과 같은 정보를 표시합니다.
68-
- **사용자 정보 변경**: 현재 로그인된 사용자 정보를 확인하거나 변경합니다.
69-
- **설정**: 사용자 설정 페이지로 이동합니다.
70-
- **로그 / 에러기록**: 사용자 설정 페이지의 로그 탭으로 이동합니다. 클라이언트 측에 기록된 로그 및 오류 내역을 확인할 수 있습니다.
71-
- **데스크톱 앱 다운로드**: 사용자의 플랫폼에 맞는 독립형 WebUI 앱을 다운로드합니다. 이 옵션은 관리자가 활성화한 경우에만 표시됩니다.
72-
- **로그아웃**: WebUI에서 로그아웃합니다.
67+
드롭다운 상단에는 다음과 같은 사용자 정보가 표시됩니다. 이 항목들은 클릭할 수 없는 참고 정보입니다.
68+
69+
- **이름**: 현재 사용자의 전체 이름.
70+
- **이메일**: 현재 사용자의 이메일 주소.
71+
- **역할**: 현재 사용자의 역할 (예: 사용자, 도메인 관리자, 슈퍼관리자).
72+
73+
사용자 정보 아래에는 다음과 같은 실행 항목이 있습니다.
74+
75+
- `Backend.AI에 대하여`: Backend.AI WebUI의 버전, 라이선스 종류 등과 같은 정보를 표시합니다.
76+
- `사용자 정보 변경`: 현재 로그인된 사용자 정보를 확인하거나 변경합니다.
77+
- `설정`: 사용자 설정 페이지로 이동합니다.
78+
- `로그 / 에러기록`: 사용자 설정 페이지의 로그 탭으로 이동합니다. 클라이언트 측에 기록된 로그 및 오류 내역을 확인할 수 있습니다.
79+
- `데스크톱 앱 다운로드`: 사용자의 플랫폼에 맞는 독립형 WebUI 앱을 다운로드합니다. 이 옵션은 관리자가 활성화한 경우에만 표시됩니다.
80+
- `로그아웃`: WebUI에서 로그아웃합니다.
7381

7482
<a id="my-account"></a>
7583

7684
### 사용자 정보 변경
7785

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

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

@@ -102,7 +110,7 @@
102110

103111
사용자가 사용하는 이중 인증 애플리케이션을 켜고 QR 코드를 스캔하거나 인증 코드를 직접 입력합니다. 이중 인증 지원 애플리케이션은 Google Authenticator, 2STP, 1Password, Bitwarden 등이 있습니다.
104112

105-
이중 인증 애플리케이션에 추가된 항목의 6자리 코드를 위 다이얼로그에 입력합니다. 확인 버튼을 누르면 이중 인증 활성화가 완료됩니다.
113+
이중 인증 애플리케이션에 추가된 항목의 6자리 코드를 위 다이얼로그에 입력합니다. `확인` 버튼을 누르면 이중 인증 활성화가 완료됩니다.
106114

107115
이후 해당 사용자의 로그인 과정에서 OTP 코드를 묻는 추가 필드가 나타납니다.
108116

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

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,26 +61,34 @@
6161
## เมนูผู้ใช้
6262

6363

64-
คลิกไอคอนผู้ใช้ที่ด้านขวาของแถบด้านบนเพื่อดูเมนูผู้ใช้ แต่ละรายการเมนูมีฟังก์ชันดังต่อไปนี้
64+
คลิกไอคอนผู้ใช้ที่ด้านขวาของแถบด้านบนเพื่อดูเมนูผู้ใช้
6565

6666
![](../images/user_drop_down.png)
6767

68-
- **เกี่ยวกับ Backend.AI**: แสดงข้อมูลเช่น เวอร์ชันของ Backend.AI WebUI ประเภทใบอนุญาต เป็นต้น
69-
- **บัญชีของฉัน**: ตรวจสอบและอัปเดตข้อมูลของผู้ใช้ที่เข้าสู่ระบบอยู่
70-
- **การตั้งค่าส่วนตัว**: ไปที่หน้าการตั้งค่าผู้ใช้
71-
- **บันทึก / ข้อผิดพลาด**: ไปที่แท็บบันทึกในหน้าการตั้งค่าผู้ใช้ คุณสามารถตรวจสอบประวัติบันทึกและข้อผิดพลาดที่บันทึกไว้ฝั่งไคลเอนต์ได้
72-
- **ดาวน์โหลดแอพเดสก์ท็อป**: ดาวน์โหลดแอป WebUI แบบสแตนด์อะโลนสำหรับแพลตฟอร์มของคุณ ตัวเลือกนี้แสดงเฉพาะเมื่อผู้ดูแลระบบเปิดใช้งาน
73-
- **ออกจากระบบ**: ออกจากระบบ WebUI
68+
ที่ด้านบนของดรอปดาวน์จะแสดงข้อมูลผู้ใช้ดังต่อไปนี้เพื่อเป็นข้อมูลอ้างอิง รายการเหล่านี้ไม่สามารถคลิกได้
69+
70+
- **ชื่อเต็ม**: ชื่อเต็มของผู้ใช้ปัจจุบัน
71+
- **อีเมล**: ที่อยู่อีเมลของผู้ใช้ปัจจุบัน
72+
- **บทบาท**: บทบาทของผู้ใช้ปัจจุบัน (เช่น ผู้ใช้, ผู้ดูแลโดเมน, ซุปเปอร์แอดมิน)
73+
74+
ด้านล่างข้อมูลผู้ใช้มีรายการการดำเนินการดังต่อไปนี้
75+
76+
- `เกี่ยวกับ Backend.AI`: แสดงข้อมูลเช่น เวอร์ชันของ Backend.AI WebUI ประเภทใบอนุญาต เป็นต้น
77+
- `บัญชีของฉัน`: ตรวจสอบและอัปเดตข้อมูลของผู้ใช้ที่เข้าสู่ระบบอยู่
78+
- `การตั้งค่าส่วนตัว`: ไปที่หน้าการตั้งค่าผู้ใช้
79+
- `บันทึก / ข้อผิดพลาด`: ไปที่แท็บบันทึกในหน้าการตั้งค่าผู้ใช้ คุณสามารถตรวจสอบประวัติบันทึกและข้อผิดพลาดที่บันทึกไว้ฝั่งไคลเอนต์ได้
80+
- `ดาวน์โหลดแอพเดสก์ท็อป`: ดาวน์โหลดแอป WebUI แบบสแตนด์อะโลนสำหรับแพลตฟอร์มของคุณ ตัวเลือกนี้แสดงเฉพาะเมื่อผู้ดูแลระบบเปิดใช้งาน
81+
- `ออกจากระบบ`: ออกจากระบบ WebUI
7482

7583
<a id="my-account"></a>
7684

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

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

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

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

8593
- **ชื่อเต็ม**: ชื่อผู้ใช้ (สูงสุด 64 ตัวอักษร)
8694
- **รหัสผ่านเดิม**: รหัสผ่านเดิม คลิกปุ่มดูทางด้านขวาเพื่อดูเนื้อหาที่ป้อน
@@ -103,7 +111,7 @@
103111

104112
เปิดแอปพลิเคชัน 2FA ที่คุณใช้และสแกนรหัส QR หรือป้อนรหัสยืนยันด้วยตนเอง มีแอปพลิเคชันที่รองรับ 2FA หลายตัว เช่น Google Authenticator, 2STP, 1Password และ Bitwarden
105113

106-
จากนั้นให้ป้อนรหัส 6 หลักจากรายการที่เพิ่มไปยังแอปพลิเคชัน 2FA ของคุณในกล่องโต้ตอบด้านบน 2FA จะถูกเปิดใช้งานเมื่อคุณกดปุ่มยืนยัน
114+
จากนั้นให้ป้อนรหัส 6 หลักจากรายการที่เพิ่มไปยังแอปพลิเคชัน 2FA ของคุณในกล่องโต้ตอบด้านบน 2FA จะถูกเปิดใช้งานเมื่อคุณกดปุ่ม `ยืนยัน`
107115

108116
เมื่อคุณเข้าสู่ระบบในภายหลัง หากคุณใส่อีเมลและรหัสผ่าน จะมีฟิลด์เพิ่มเติมปรากฏขึ้นเพื่อขอรหัส OTP
109117

0 commit comments

Comments
 (0)