Skip to content

Commit c04a6e6

Browse files
committed
docs: remove superadmin dashboard content, translate ja/import_run, fix ko/import_run button label
- Remove superadmin dashboard section and related notes from dashboard.md (en/ko/ja/th) per reviewer feedback (superadmin dashboard is hidden) - Translate ja/import_run/import_run.md fully to Japanese (previously contained untranslated English sentences) - Update ko/import_run/import_run.md button label: `Create` -> `가져오기` per reviewer suggestion
1 parent 073d1d9 commit c04a6e6

6 files changed

Lines changed: 18 additions & 247 deletions

File tree

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

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -39,21 +39,12 @@ system configuration.
3939
session type, and creation time.
4040
By default, the latest 5 active sessions are displayed.
4141

42-
When you are logged in as a superadmin, the Dashboard page also displays
43-
**Agent Statistics** and **Active Agents** panels alongside the standard user panels.
44-
See the [Superadmin Dashboard](#superadmin-dashboard) section for details on these panels.
45-
4642
## Auto-Refresh
4743

4844
The Dashboard automatically refreshes all panel data every **15 seconds**. This
4945
ensures that the displayed information stays up to date without requiring manual
5046
interaction.
5147

52-
:::note
53-
The superadmin dashboard uses a **30-second** refresh interval instead.
54-
See the [Superadmin Dashboard](#superadmin-dashboard) section for more information.
55-
:::
56-
5748
## Customizing the Dashboard Layout
5849

5950
You can customize the Dashboard layout by rearranging and resizing panels to
@@ -71,50 +62,3 @@ preferred arrangement.
7162
When the WebUI is updated with new dashboard panels, those panels will
7263
automatically appear on your dashboard even if you have a saved custom layout.
7364
:::
74-
75-
:::note
76-
The user dashboard and the superadmin dashboard maintain separate saved layouts.
77-
Customizing the layout on one does not affect the other.
78-
:::
79-
80-
## Superadmin Dashboard
81-
82-
The superadmin dashboard is a separate page available to superadmin users. It
83-
provides system-wide monitoring panels with a different set of panels from the
84-
user dashboard.
85-
86-
![](../images/admin_dashboard.png)
87-
88-
The superadmin dashboard includes the following panels:
89-
90-
- **Active Sessions**:
91-
Shows the total number of active sessions across current projects,
92-
categorized by session type.
93-
94-
- **Total Resources in Resource Group**:
95-
Summarizes the overall used and free resources in the selected resource group,
96-
aggregated from all agents. This panel may not be visible depending on the
97-
system configuration.
98-
99-
- **Agent Statistics**:
100-
Provides all used resources across all agents in the system.
101-
The values represent the total used resources by all active sessions.
102-
103-
:::note
104-
The **Agent Statistics** panel requires backend support for the agent-stats
105-
feature and may not appear in all deployments.
106-
:::
107-
108-
- **Active Agents**:
109-
Lists all currently active agents in the system.
110-
111-
- **Recently Created Sessions**:
112-
Lists the most recently created active sessions within the current project.
113-
114-
:::note
115-
Unlike the user dashboard, the superadmin dashboard does **not** include the
116-
**My Total Resources Limit** or **My Resources in Resource Group** panels.
117-
:::
118-
119-
The superadmin dashboard refreshes all panel data every **30 seconds**, compared
120-
to the user dashboard's 15-second interval.

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

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,10 @@
2525
- **最近作成されたセッション:**
2626
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。セッション名、ステータス、CPU/メモリ使用量、環境、リソースグループ、セッションタイプ、作成日時などの詳細を確認できます。デフォルトでは最新の5つのアクティブなセッションが表示されます。
2727

28-
スーパー管理者としてログインしている場合、ダッシュボードページには通常のユーザーパネルに加えて、**エージェントの統計**および**アクティブなエージェント**パネルも表示されます。これらのパネルの詳細については、[スーパー管理者ダッシュボード](#superadmin-dashboard)セクションを参照してください。
29-
3028
## 自動更新
3129

3230
ダッシュボードは**15秒**ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
3331

34-
:::note
35-
スーパー管理者ダッシュボードでは、**30秒**間隔で更新されます。
36-
詳細については、[スーパー管理者ダッシュボード](#superadmin-dashboard)セクションを参照してください。
37-
:::
38-
3932
## ダッシュボードレイアウトのカスタマイズ
4033

4134
パネルの再配置やサイズ変更により、ダッシュボードのレイアウトをお好みに合わせてカスタマイズできます。
@@ -49,46 +42,3 @@
4942
WebUIの更新で新しいダッシュボードパネルが追加された場合、保存済みのカスタムレイアウトが
5043
あっても、新しいパネルは自動的にダッシュボードに表示されます。
5144
:::
52-
53-
:::note
54-
ユーザーダッシュボードとスーパー管理者ダッシュボードのレイアウトは別々に保存されます。
55-
一方のレイアウトを変更しても、もう一方には影響しません。
56-
:::
57-
58-
<a id="superadmin-dashboard"></a>
59-
60-
## スーパー管理者ダッシュボード
61-
62-
スーパー管理者ダッシュボードは、スーパー管理者ユーザーが利用できる専用ページです。ユーザーダッシュボードとは異なるパネル構成で、システム全体をモニタリングするためのパネルを提供します。
63-
64-
![](../images/admin_dashboard.png)
65-
66-
スーパー管理者ダッシュボードには以下のパネルが含まれます:
67-
68-
- **アクティブセッション:**
69-
現在のプロジェクトのアクティブなセッション総数をセッションタイプ別に分類して表示します。
70-
71-
- **リソースグループの総リソース:**
72-
選択されたリソースグループ全体の使用量と空き容量を、すべてのエージェントを集計して要約表示します。
73-
このパネルはシステム構成によって表示されない場合があります。
74-
75-
- **エージェントの統計:**
76-
システム内のすべてのエージェントで使用中のリソース状況を提供します。表示される値は、すべてのアクティブなセッションが使用しているリソースの総量です。
77-
78-
:::note
79-
**エージェントの統計**パネルはバックエンドのagent-stats機能のサポートが必要であり、
80-
デプロイメント環境によっては表示されない場合があります。
81-
:::
82-
83-
- **アクティブなエージェント:**
84-
システムで現在アクティブなすべてのエージェントの一覧を表示します。
85-
86-
- **最近作成されたセッション:**
87-
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。
88-
89-
:::note
90-
ユーザーダッシュボードとは異なり、スーパー管理者ダッシュボードには**私の総リソース制限**
91-
および**リソースグループの私のリソース**パネルは含まれません。
92-
:::
93-
94-
スーパー管理者ダッシュボードは、ユーザーダッシュボードの15秒間隔と比べて、**30秒**ごとにすべてのパネルデータを更新します。
Lines changed: 17 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,69 @@
11
# ノートブックとウェブベースのGitリポジトリをインポートして実行
22

33

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

1412

1513
:::note
16-
ローカルアドレスでJupyterノートブックファイルをインポート&実行しようとする場合、それは無効と見なされます。localhostで始まらないURLを入力する必要があります
14+
ローカルアドレスのJupyterノートブックファイルをインポート&実行しようとする場合、それは無効と見なされます。localhostで始まらないURLを入力してください
1715
:::
1816

1917
![](../images/import_run_notebook.png)
2018

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.
19+
ボタンをクリックするとダイアログが表示されます。このダイアログは、セッションページや要約ページでセッションを開始するときと同じセッションランチャーです。ノートブックのインポートと新しいセッションの開始の違いは、ノートブックのインポート時にはURL内のJupyterノートブックが自動的にインポートされる点です。その他は同じです。必要に応じて環境とリソースの割り当てを設定してから、`開始` ボタンをクリックします。
2620

2721
:::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.
22+
`開始` ボタンをクリックする前にポップアップブロッカーを解除しておくと、実行中のノートブックウィンドウをすぐに確認できます。また、セッションを実行するのに十分なリソースがない場合、インポートされたJupyterノートブックは実行されません。
3123
:::
3224

3325
![](../images/session_launcher_in_importing_notebook.png)
3426

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

3729
![](../images/sessions_page_with_imported_notebook.png)
3830

3931
<a id="create-executable-jupyter-notebook-button"></a>
4032

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.
33+
## 実行可能なJupyterノートブックボタンの生成
4734

35+
Jupyter notebook URLに対するHTMLまたはMarkdownボタンを生成することもできます。有効なJupyter notebook URLを入力し、`作成する` ボタンをクリックします。ノートブックでセッションを生成するリンクを含むコードブロックが表示されます。このバッジコードをGitHubリポジトリや、HTMLまたはMarkdownをサポートする場所に挿入して使用できます。
4836

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

5341
![](../images/create_notebook_button.png)
5442

5543
<a id="importing-github-repositories"></a>
5644

57-
## Importing GitHub Repositories
45+
## GitHubリポジトリのインポート
5846

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.
47+
GitHubリポジトリのインポートは、Jupyterノートブックのインポート & 実行と似ています。GitHubリポジトリのURLを入力し、`フォルダに移動` ボタンをクリックするだけです。複数のストレージホストにアクセスできる場合は、リストから1つを選択できます。
6248

6349
![](../images/import_github_repository.png)
6450

6551
:::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.
52+
セッションを開始するのに十分なリソースがない場合やフォルダ数が上限に達している場合、リポジトリのインポートは失敗します。リポジトリをインポートする前に、リソース統計パネルとデータ & ストレージページを確認してください。
6953
:::
7054

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

7457
![](../images/import_github_repository_result.png)
7558

7659
<a id="importing-gitlab-repositories"></a>
7760

78-
## Importing GitLab Repositories
61+
## GitLabリポジトリのインポート
7962

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.
63+
22.03 バージョンから、Backend.AIはGitLabからのインポートをサポートします。[GitHubリポジトリのインポート](#importing-github-repositories) とほぼ同じですが、インポートするブランチ名を明示的に設定する必要があります。
8364

8465
![](../images/import_gitlab_repository.png)
8566

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

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

Lines changed: 0 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -27,19 +27,10 @@
2727
- **최근 생성 세션:**
2828
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다. 세션 이름, 상태, CPU/메모리 사용량, 환경, 자원 그룹, 세션 유형, 생성 일시 등을 확인할 수 있습니다. 기본적으로 최근 5개의 실행 중인 세션이 표시됩니다.
2929

30-
슈퍼관리자로 로그인한 경우, 대시보드 페이지에 일반 사용자 패널과 함께
31-
**에이전트 통계****활성 에이전트** 패널이 추가로 표시됩니다.
32-
이 패널에 대한 자세한 내용은 [슈퍼관리자 대시보드](#superadmin-dashboard) 섹션을 참고하세요.
33-
3430
## 자동 새로고침
3531

3632
대시보드는 모든 패널 데이터를 **15초**마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
3733

38-
:::note
39-
슈퍼관리자 대시보드는 **30초** 간격으로 새로고침됩니다.
40-
자세한 내용은 [슈퍼관리자 대시보드](#superadmin-dashboard) 섹션을 참고하세요.
41-
:::
42-
4334
## 대시보드 레이아웃 커스터마이즈
4435

4536
패널을 재배치하거나 크기를 조정하여 대시보드 레이아웃을 원하는 대로 커스터마이즈할 수 있습니다.
@@ -53,46 +44,3 @@
5344
WebUI 업데이트로 새로운 대시보드 패널이 추가되면, 저장된 커스텀 레이아웃이 있더라도
5445
새 패널이 대시보드에 자동으로 표시됩니다.
5546
:::
56-
57-
:::note
58-
사용자 대시보드와 슈퍼관리자 대시보드의 레이아웃은 별도로 저장됩니다.
59-
한쪽의 레이아웃을 변경해도 다른 쪽에는 영향을 주지 않습니다.
60-
:::
61-
62-
<a id="superadmin-dashboard"></a>
63-
64-
## 슈퍼관리자 대시보드
65-
66-
슈퍼관리자 대시보드는 슈퍼관리자 사용자에게 제공되는 별도의 페이지입니다. 사용자 대시보드와 다른 패널 구성으로 시스템 전체를 모니터링할 수 있는 패널을 제공합니다.
67-
68-
![](../images/admin_dashboard.png)
69-
70-
슈퍼관리자 대시보드에는 다음 패널이 포함됩니다.
71-
72-
- **활성 세션:**
73-
현재 프로젝트에서 실행 중인 세션의 총 개수를 세션 유형별로 분류하여 표시합니다.
74-
75-
- **자원 그룹 내 총자원:**
76-
선택된 자원 그룹 전체의 사용량과 가용량을 모든 에이전트를 합산하여 요약 표시합니다.
77-
이 패널은 시스템 구성에 따라 표시되지 않을 수 있습니다.
78-
79-
- **에이전트 통계:**
80-
시스템 내 모든 에이전트의 사용 중인 자원 현황을 제공합니다. 표시된 값은 모든 활성 세션이 사용 중인 자원의 총합입니다.
81-
82-
:::note
83-
**에이전트 통계** 패널은 백엔드의 agent-stats 기능 지원이 필요하며,
84-
배포 환경에 따라 표시되지 않을 수 있습니다.
85-
:::
86-
87-
- **활성 에이전트:**
88-
시스템에서 현재 활성화된 모든 에이전트 목록을 표시합니다.
89-
90-
- **최근 생성 세션:**
91-
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다.
92-
93-
:::note
94-
사용자 대시보드와 달리, 슈퍼관리자 대시보드에는 **나의 총자원 제한**
95-
**자원 그룹 내 나의 자원** 패널이 포함되지 않습니다.
96-
:::
97-
98-
슈퍼관리자 대시보드는 사용자 대시보드의 15초 간격과 달리 **30초**마다 모든 패널 데이터를 새로고침합니다.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Jupyter notebook 파일을 가져와서 실행하기 위해서는 notebook 파
3232

3333
## 실행 가능한 Jupyter notebook 버튼 생성
3434

35-
Jupyter notebook URL에 대한 HTML 또는 Markdown 버튼을 생성할 수도 있습니다. 유효한 Jupyter notebook URL을 입력하고 `Create` 버튼을 클릭합니다. notebook으로 세션을 생성하는 링크가 포함된 코드 블록이 표시됩니다. 이 배지 코드를 GitHub 저장소나 HTML 또는 Markdown을 지원하는 곳에 삽입하여 사용할 수 있습니다.
35+
Jupyter notebook URL에 대한 HTML 또는 Markdown 버튼을 생성할 수도 있습니다. 유효한 Jupyter notebook URL을 입력하고 `가져오기` 버튼을 클릭합니다. notebook으로 세션을 생성하는 링크가 포함된 코드 블록이 표시됩니다. 이 배지 코드를 GitHub 저장소나 HTML 또는 Markdown을 지원하는 곳에 삽입하여 사용할 수 있습니다.
3636

3737
:::note
3838
버튼을 클릭하기 전에 계정에 로그인되어 있어야 합니다. 그렇지 않으면 먼저 로그인해야 합니다.

0 commit comments

Comments
 (0)