Skip to content

Commit 573292d

Browse files
committed
docs(FR-2533): update user_settings with new settings and remove obsolete ones (#6571)
Resolves #6677 (FR-2533) ## Summary - Update language selector documentation with full list of 20 supported languages and searchable dropdown behavior - Document the new **AI Agents** experimental feature in User Settings - Add a note about keypair information dialog showing a table view with extended management options - Fix import_run button labels to match current UI text ## Changes - `user_settings/user_settings.md` (en/ko/ja/th): language selector details, AI Agents experimental feature, keypair note - `import_run/import_run.md` (en/ko/ja/th): corrected button label references ## Test plan - [ ] Verify language list (20 languages) matches the actual UI - [ ] Verify AI Agents toggle is visible under Experimental Features - [ ] Verify keypair dialog note is accurate 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent b106e27 commit 573292d

8 files changed

Lines changed: 167 additions & 122 deletions

File tree

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

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ and click the button on the right side.
1212

1313
To import Jupyter notebooks and run, you need one thing, the valid URL for the notebook file.
1414
For example, if you want execute Jupyter notebook that's in github, you can copy and paste
15-
the URL and click 'IMPORT & RUN' button.
15+
the URL and click the 'Import & Run' button.
1616

1717
:::note
18-
When you trying to IMPORT & RUN Jupyter notebook file with local address,
19-
It will be regarded as invalid. You have to input URL which is not starting from localhost.
18+
When you try to import and run a Jupyter notebook file with a local address,
19+
it will be regarded as invalid. You have to input a URL that does not start with localhost.
2020
:::
2121

2222
![](../images/import_run_notebook.png)
@@ -43,13 +43,14 @@ You can see the importing operation is successfully completed in Sessions page.
4343

4444
## Create executable Jupyter notebook button
4545

46-
You can also create HTML or Markdown button about Jupyter notebook URL, too.
47-
Input a valid Jupyter notebook URL and click 'CREATE' button. It will show code blocks that directly
48-
links to creating a session with notebook. You can see the badge code working by inserting it in
49-
the GitHub repositories or where it supports html or markdown.
46+
You can also create an HTML or Markdown badge for a Jupyter notebook URL.
47+
Input a valid Jupyter notebook URL and click the `Notebook Badge Code (HTML)` or
48+
`Notebook Badge Code (Markdown)` copy button to copy the badge code to your clipboard.
49+
The badge code creates a link that directly opens a session with the notebook.
50+
You can use the badge code by inserting it in GitHub repositories or anywhere that supports HTML or Markdown.
5051

5152
:::note
52-
your account must be logined before clicking the button. Otherwise, you have to login first.
53+
Your account must be logged in before clicking the button. Otherwise, you have to log in first.
5354
:::
5455

5556
![](../images/create_notebook_button.png)
@@ -59,8 +60,8 @@ your account must be logined before clicking the button. Otherwise, you have to
5960
## Importing GitHub Repositories
6061

6162
Importing a GitHub repository is similar to import and running Jupyter notebook.
62-
All you have to do is to fill out with github repository URL and click 'GET TO
63-
FOLDER' button. If you can access to more than one storage host, you can select one from the list.
63+
All you have to do is fill in the GitHub repository URL, select a storage host from the
64+
`Storage Host` dropdown, and click the `Get To Folder` button.
6465

6566
![](../images/import_github_repository.png)
6667

@@ -70,7 +71,7 @@ the limit, then importing repository will fail. Please check resource
7071
statistics panel and Data & Storage page before importing the repository.
7172
:::
7273

73-
You can see the repository is successfully imported as a data folder with its
74+
You can see the repository is successfully imported as a storage folder with its
7475
name.
7576

7677
![](../images/import_github_repository_result.png)
@@ -86,6 +87,6 @@ but you need to explicitly set the branch name to import.
8687
![](../images/import_gitlab_repository.png)
8788

8889
:::note
89-
If there's data folder that has the same name already, the system will append
90+
If there's a storage folder that has the same name already, the system will append
9091
`_` (underscore) and number in the imported repository folder.
9192
:::

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

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ experimental features.
1717
![](../images/user_settings_page.png)
1818

1919
The General tab contains all preference settings organized into groups:
20-
**Preferences**, **Shell Environments**, and **Experimental Features**.
20+
**Preferences**, **Shell Environments**, and **Experimental features**.
2121

2222
### Searching and Filtering Settings
2323

@@ -65,10 +65,20 @@ the leftmost icon at the top of the header.
6565

6666
### Language
6767

68-
Set the interface language. Currently, Backend.AI supports more than twenty
69-
languages including English and Korean. Languages other than English and Korean
70-
are provided via machine translation. Some UI items may not update their language
71-
before the page is refreshed.
68+
Set the interface language. The language selector is a searchable dropdown that
69+
lists 20 languages: English, 한국어 (Korean), brasileiro (Brazilian Portuguese),
70+
简体中文 (Simplified Chinese), 繁體中文 (Traditional Chinese), Français (French),
71+
Suomalainen (Finnish), Deutsch (German), Ελληνική (Greek),
72+
Bahasa Indonesia (Indonesian), Italiano (Italian), 日本語 (Japanese),
73+
Монгол (Mongolian), Polski (Polish), Português (Portuguese), русский (Russian),
74+
Español (Spanish), ภาษาไทย (Thai), Türkçe (Turkish), and
75+
Tiếng Việt (Vietnamese). You can type in the dropdown to filter and quickly
76+
find a language.
77+
78+
The language that matches your browser's default is indicated with a "(Default)"
79+
label next to its name. Languages other than English and Korean are provided via
80+
machine translation. Some UI items may not update their language before the page
81+
is refreshed.
7282

7383
:::note
7484
Some translated items may be marked as `__NOT_TRANSLATED__`, which
@@ -106,6 +116,12 @@ by clicking the Config button. Remember that only one main access keypair exists
106116

107117
![](../images/my_keypair_information.png)
108118

119+
:::note
120+
Depending on the server version, the keypair information dialog may display
121+
a table view with additional management options such as issuing new keypairs,
122+
deactivating, or revoking existing ones.
123+
:::
124+
109125
<a id="user-ssh-keypair-management"></a>
110126

111127
### SSH Keypair Management
@@ -115,7 +131,7 @@ compute session. Once you sign up for Backend.AI, a public keypair is
115131
provided. If you click the button on the right of the SSH Keypair Management
116132
section, the following dialog appears. Click the copy button on the right to
117133
copy the existing SSH public key. You can update the SSH keypair by clicking
118-
the GENERATE button at the bottom of the dialog. SSH public/private keys are
134+
the `GENERATE` button at the bottom of the dialog. SSH public/private keys are
119135
randomly generated and stored as user information. Please note that the secret
120136
key cannot be checked again unless it is saved manually immediately after
121137
creation.
@@ -177,11 +193,15 @@ the script.
177193

178194
### Experimental Features
179195

180-
You can enable or disable experimental features before they are officially
181-
released. These may change or be removed in future updates.
196+
Access new experimental features early -- these may change or be removed in
197+
future updates.
182198

183199
![](../images/experimental_features.png)
184200

201+
- **AI Agents**: Enable the AI Agents feature, which provides agent-based AI
202+
capabilities within the WebUI. When turned on, AI agent functionality becomes
203+
available for use in your sessions.
204+
185205
## Logs Tab
186206

187207
Displays detailed information of various logs recorded on the client side. You
Lines changed: 25 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# ノートブックとウェブベースのGitリポジトリをインポートして実行
22

33

4-
On the 'Import & Run' page, Backend.AIは、Jupyterノートブックファイルの実行や、GitHubやGitLabなどのウェブベースのGitリポジトリの即時インポートをサポートしています。ローカルストレージに作成またはダウンロードして再アップロードする必要はありません。実行またはインポートしたい有効なURLを入力し、右側のボタンをクリックするだけです。
4+
「インポート & 実行」ページでは、Backend.AIがJupyterノートブックファイルの実行や、GitHubやGitLabなどのウェブベースのGitリポジトリの即時インポートをサポートしています。ローカルストレージに作成またはダウンロードして再アップロードする必要はありません。実行またはインポートしたい有効なURLを入力し、右側のボタンをクリックするだけです。
55

66
<a id="import-and-run-jupyter-notebooks"></a>
77

88
## Jupyterノートブックをインポートして実行する
99

10-
To import Jupyter notebooks and run, you need one thing, the valid URL for the notebook file.
11-
For example, if you want execute Jupyter notebook that's in github, you can copy and paste
12-
the URL and click 'IMPORT & RUN' button.
10+
Jupyterノートブックをインポートして実行するには、ノートブックファイルの有効なURLが必要です。
11+
例えば、GitHubにあるJupyterノートブックを実行したい場合、そのURLをコピーして貼り付け、
12+
「インポート & 実行」ボタンをクリックします。
1313

1414

1515
:::note
@@ -18,73 +18,62 @@ the URL and click 'IMPORT & RUN' button.
1818

1919
![](../images/import_run_notebook.png)
2020

21-
After clicking the button, the dialog appears. This is a session launcher dialog same as
22-
when you starts the session at Sessions page or Summary page. Difference between import notebook
23-
and starting a new session is that import notebook automatically imports Jupyter notebook in the
24-
URL, but simple starting a new session doesn't do that. the rest is same. Click 'LAUNCH' button to
25-
the notebook after setting the environments and resource allocation as needed.
21+
ボタンをクリックすると、ダイアログが表示されます。これはセッションページやサマリーページからセッションを開始する場合と同じセッションランチャーダイアログです。ノートブックのインポートと新しいセッションの開始の違いは、ノートブックのインポートではURLにあるJupyterノートブックが自動的にインポートされることです。残りは同じです。必要に応じて環境とリソース配分を設定した後、「Launch」ボタンをクリックします。
2622

2723
:::note
28-
The pop-up blocker must be turned off before clicking 'LAUNCH' button to immediately
29-
see the running notebook window. Also, if there's not enough resources to execute the session,
30-
imported Jupyter notebook will not run.
24+
「Launch」ボタンをクリックする前に、ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされたJupyterノートブックは実行されません。
3125
:::
3226

3327
![](../images/session_launcher_in_importing_notebook.png)
3428

35-
You can see the importing operation is successfully completed in Sessions page.
29+
セッションページでインポート操作が正常に完了したことを確認できます。
3630

3731
![](../images/sessions_page_with_imported_notebook.png)
3832

3933
<a id="create-executable-jupyter-notebook-button"></a>
4034

41-
## Create executable Jupyter notebook button
42-
43-
You can also create HTML or Markdown button about Jupyter notebook URL, too.
44-
Input a valid Jupyter notebook URL and click 'CREATE' button. It will show code blocks that directly
45-
links to creating a session with notebook. You can see the badge code working by inserting it in
46-
the GitHub repositories or where it supports html or markdown.
35+
## 実行可能なJupyterノートブックバッジの作成
4736

37+
JupyterノートブックURLのHTMLまたはMarkdownバッジを作成することもできます。
38+
有効なJupyterノートブックURLを入力し、「ノートブックバッジコード(HTML)」または
39+
「ノートブックバッジコード(マークダウン)」コピーボタンをクリックすると、バッジコードがクリップボードにコピーされます。
40+
バッジコードは、ノートブックでセッションを直接作成するリンクを含みます。
41+
このバッジコードをGitHubリポジトリやHTMLまたはMarkdownをサポートする場所に挿入して使用できます。
4842

4943
:::note
50-
your account must be logined before clicking the button. Otherwise, you have to login first.
44+
ボタンをクリックする前にアカウントにログインしている必要があります。ログインしていない場合は、まずログインしてください。
5145
:::
5246

5347
![](../images/create_notebook_button.png)
5448

5549
<a id="importing-github-repositories"></a>
5650

57-
## Importing GitHub Repositories
51+
## GitHubリポジトリのインポート
5852

59-
Importing a GitHub repository is similar to import and running Jupyter notebook.
60-
All you have to do is to fill out with github repository URL and click 'GET TO
61-
FOLDER' button. If you can access to more than one storage host, you can select one from the list.
53+
GitHubリポジトリのインポートは、Jupyterノートブックのインポートと実行に似ています。
54+
GitHubリポジトリのURLを入力し、「ストレージホスト」ドロップダウンからストレージホストを選択して、
55+
「フォルダに移動」ボタンをクリックするだけです。
6256

6357
![](../images/import_github_repository.png)
6458

6559
:::note
66-
If there are not enough resources to start a session or folder count is at
67-
the limit, then importing repository will fail. Please check resource
68-
statistics panel and Data & Storage page before importing the repository.
60+
セッションを開始するためのリソースが不足している場合やフォルダ数が制限に達している場合、リポジトリのインポートは失敗します。リポジトリをインポートする前に、リソース統計パネルとデータ&ストレージページを確認してください。
6961
:::
7062

71-
You can see the repository is successfully imported as a data folder with its
72-
name.
63+
リポジトリがその名前のストレージフォルダとして正常にインポートされたことを確認できます。
7364

7465
![](../images/import_github_repository_result.png)
7566

7667
<a id="importing-gitlab-repositories"></a>
7768

78-
## Importing GitLab Repositories
69+
## GitLabリポジトリのインポート
7970

80-
From 22.03, Backend.AI supports importing from GitLab. It's almost the same as
81-
[Importing GitHub Repositories](#importing-github-repositories),
82-
but you need to explicitly set the branch name to import.
71+
22.03から、Backend.AIはGitLabからのインポートをサポートしています。
72+
[GitHubリポジトリのインポート](#importing-github-repositories)とほぼ同じですが、
73+
インポートするブランチ名を明示的に設定する必要があります。
8374

8475
![](../images/import_gitlab_repository.png)
8576

86-
8777
:::note
88-
If there's data folder that has the same name already, the system will append
89-
`_` (underscore) and number in the imported repository folder.
78+
同じ名前のストレージフォルダがすでに存在する場合、システムはインポートされたリポジトリフォルダ名に`_`(アンダースコア)と番号を追加します。
9079
:::

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

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
設定エリアの上部にある**検索バー**を使用して、設定名ですばやく検索できます。
2424
キーワードを入力すると、一致する設定のみが表示されます。
2525

26-
**変更のみ表示**チェックボックスをオンにすると、デフォルト値から変更された
26+
**表示のみの変更**チェックボックスをオンにすると、デフォルト値から変更された
2727
設定のみをフィルタリングして表示できます。これにより、カスタマイズした
2828
すべての項目を一目で確認できます。
2929

@@ -60,9 +60,16 @@ WebUIの表示モードを設定します。以下から選択できます:
6060

6161
### 言語
6262

63-
UIに表示される言語を設定します。現在、Backend.AIは英語と韓国語を含む20以上の
64-
言語をサポートしています。英語と韓国語以外の言語は機械翻訳で提供されます。
65-
ページを更新するまで言語が更新されないUIアイテムがある場合があります。
63+
UIに表示される言語を設定します。言語セレクタは検索可能なドロップダウンで、
64+
English、한국어、brasileiro、简体中文、繁體中文、Français、Suomalainen、Deutsch、
65+
Ελληνική、Bahasa Indonesia、Italiano、日本語、Монгол、Polski、Português、
66+
русский、Español、ภาษาไทย、Türkçe、Tiếng Việtの20言語がリストされています。
67+
ドロップダウンに入力して、言語をすばやくフィルタリングして見つけることが
68+
できます。
69+
70+
ブラウザのデフォルト言語と一致する項目には、名前の横に「(Default)」ラベルが
71+
表示されます。英語と韓国語以外の言語は機械翻訳で提供されます。ページを更新する
72+
まで言語が更新されないUIアイテムがある場合があります。
6673

6774
:::note
6875
一部の翻訳項目は`__NOT_TRANSLATED__`と表示される場合があります。これは、
@@ -101,15 +108,21 @@ https://github.com/lablup/backend.ai-webui.
101108

102109
![](../images/my_keypair_information.png)
103110

111+
:::note
112+
サーバーバージョンによっては、キーペア情報ダイアログに新しいキーペアの発行、
113+
無効化、取り消しなどの追加管理オプションを含むテーブルビューが表示される
114+
場合があります。
115+
:::
116+
104117
<a id="user-ssh-keypair-management"></a>
105118

106119
### SSHキーペア管理
107120

108121
WebUIアプリを使用する際、コンピュートセッションに直接SSH/SFTP接続を作成でき
109-
ます。Backend.AIにサインアップすると、公開鍵ペアが提供されます。SSHキーペア
122+
ます。Backend.AIにサインアップすると、公開キーペアが提供されます。SSHキーペア
110123
管理セクションの右側にあるボタンをクリックすると、次のダイアログが表示されます。
111124
右側のコピーボタンをクリックして、既存のSSH公開鍵をコピーできます。ダイアログ
112-
の下部にあるGENERATEボタンをクリックすると、SSHキーペアを更新できます。SSH
125+
の下部にある`GENERATE`ボタンをクリックすると、SSHキーペアを更新できます。SSH
113126
公開/秘密鍵はランダムに生成され、ユーザー情報として保存されます。秘密鍵は作成
114127
後すぐに手動で保存しない限り、再確認できないことに注意してください。
115128

@@ -168,11 +181,15 @@ Backend.AIセッションにアクセスできます。
168181

169182
### 実験的特徴
170183

171-
実験的機能を正式リリース前に有効または無効にできます。これらの機能は将来の
172-
アップデートで変更または削除される可能性があります
184+
新しい実験的機能に早期アクセスできます。これらは将来のアップデートで変更または
185+
削除される可能性があります
173186

174187
![](../images/experimental_features.png)
175188

189+
- **AIエージェント**: AIエージェント機能を有効にします。この機能はWebUI内で
190+
エージェントベースのAI機能を提供します。有効にすると、セッションでAI
191+
エージェント機能を利用できるようになります。
192+
176193
## ログタブ
177194

178195
クライアント側で記録されたさまざまなログの詳細情報を表示します。このページを

0 commit comments

Comments
 (0)