Skip to content

Commit 37f6b0b

Browse files
committed
docs(FR-2538): fix button labels in import_run documentation (#6576)
Resolves #6682 (FR-2538) ## Summary - Update import_run documentation to reflect current UI button labels and direct-launch behavior - Replace outdated button references (`IMPORT & RUN` → `Import & Run`, `GET TO FOLDER` → `Get To Folder`) - Update the Import Notebook workflow to describe the updated "Import & Run" / "Start with options" split button behavior - Update badge code copy button label references - Apply reviewer fixes for grammar and accuracy ## Changes - `import_run/import_run.md` (en/ko/ja/th): corrected button labels, updated workflow description, badge code copy button labels ## Test plan - [ ] Verify button labels match the current Import & Run page UI - [ ] Verify the split button (Import & Run / Start with options) behavior description is accurate 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent 3661e82 commit 37f6b0b

4 files changed

Lines changed: 53 additions & 35 deletions

File tree

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

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,18 @@ it will be regarded as invalid. You must input a URL that does not start with `l
2121

2222
![](../images/import_run_notebook.png)
2323

24-
After clicking the button, a dialog appears. This is the same session launcher dialog that appears
25-
when you start a session from the Sessions page or Summary page. The difference between importing a notebook
26-
and starting a new session is that importing a notebook automatically imports the Jupyter notebook from the
27-
URL. The rest is the same. Set the environment and resource allocation as needed, then click the `Launch` button.
24+
After clicking the `Import & Run` button, a session is created directly with default settings.
25+
You do not need to configure the session launcher manually. The notebook file is automatically
26+
downloaded into the session via the URL you provided.
27+
28+
If you want to customize the environment or resource allocation before launching, click the
29+
dropdown button next to `Import & Run` and select `Start with options`. This opens the full
30+
session launcher page where you can adjust settings before starting the session.
2831

2932
:::note
30-
The pop-up blocker must be turned off before clicking the `Launch` button to immediately
31-
see the running notebook window. Also, if there are not enough resources to execute the session,
32-
the imported Jupyter notebook will not run.
33+
The pop-up blocker must be turned off to immediately see the running notebook window.
34+
Also, if there are not enough resources to execute the session, the imported Jupyter
35+
notebook will not run.
3336
:::
3437

3538
![](../images/session_launcher_in_importing_notebook.png)
@@ -40,7 +43,7 @@ You can see the importing operation is successfully completed on the Sessions pa
4043

4144
<a id="create-executable-jupyter-notebook-button"></a>
4245

43-
## Create Executable Jupyter Notebook Button
46+
## Create Executable Jupyter Notebook Badge
4447

4548
You can also create an HTML or Markdown badge for a Jupyter notebook URL.
4649
Input a valid Jupyter notebook URL and click the `Notebook Badge Code (HTML)` or
@@ -62,10 +65,13 @@ Importing a GitHub repository is similar to importing and running a Jupyter note
6265
All you have to do is fill in the GitHub repository URL, select a storage host from the
6366
`Storage Host` dropdown, and click the `Get To Folder` button.
6467

68+
Clicking `Get To Folder` automatically creates a storage folder with the repository name
69+
and starts a batch session to download and extract the repository contents into it.
70+
6571
![](../images/import_github_repository.png)
6672

6773
:::note
68-
If there are not enough resources to start a session or the folder count is at
74+
If there are not enough resources to start a session or folder count is at
6975
the limit, then importing the repository will fail. Please check the resource
7076
statistics panel and Data & Storage page before importing the repository.
7177
:::
@@ -86,6 +92,6 @@ but you need to explicitly set the branch name to import.
8692
![](../images/import_gitlab_repository.png)
8793

8894
:::note
89-
If there is a storage folder that has the same name already, the system will append
90-
`_` (underscore) and a number to the imported repository folder name.
95+
If there's a storage folder that has the same name already, the system will append
96+
`_` (underscore) and number in the imported repository folder.
9197
:::

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
Jupyterノートブックをインポートして実行するには、ノートブックファイルの有効なURLが必要です。
1111
例えば、GitHubにあるJupyterノートブックを実行したい場合、そのURLをコピーして貼り付け、
12-
インポート & 実行ボタンをクリックします。
12+
`インポート & 実行`ボタンをクリックします。
1313

1414

1515
:::note
@@ -18,10 +18,12 @@ Jupyterノートブックをインポートして実行するには、ノート
1818

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

21-
ボタンをクリックすると、ダイアログが表示されます。これはセッションページやサマリーページからセッションを開始する場合と同じセッションランチャーダイアログです。ノートブックのインポートと新しいセッションの開始の違いは、ノートブックのインポートではURLにあるJupyterノートブックが自動的にインポートされることです。残りは同じです。必要に応じて環境とリソース配分を設定した後、「ローンチ」ボタンをクリックします。
21+
`インポート & 実行`ボタンをクリックすると、デフォルト設定でセッションが直接作成されます。セッションランチャーを手動で設定する必要はありません。入力したURLを通じて、ノートブックファイルがセッションに自動的にダウンロードされます。
22+
23+
環境やリソース配分をカスタマイズしてから起動したい場合は、`インポート & 実行`ボタンの横にあるドロップダウンボタンをクリックし、`オプション付きで開始`を選択します。これにより、セッションを開始する前に設定を調整できる完全なセッションランチャーページが開きます。
2224

2325
:::note
24-
「ローンチ」ボタンをクリックする前に、ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされたJupyterノートブックは実行されません。
26+
ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされたJupyterノートブックは実行されません。
2527
:::
2628

2729
![](../images/session_launcher_in_importing_notebook.png)
@@ -35,8 +37,8 @@ Jupyterノートブックをインポートして実行するには、ノート
3537
## 実行可能なJupyterノートブックバッジの作成
3638

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

@@ -51,8 +53,10 @@ JupyterノートブックURLのHTMLまたはMarkdownバッジを作成するこ
5153
## GitHubリポジトリのインポート
5254

5355
GitHubリポジトリのインポートは、Jupyterノートブックのインポートと実行に似ています。
54-
GitHubリポジトリのURLを入力し、「ストレージホスト」ドロップダウンからストレージホストを選択して、
55-
「フォルダに移動」ボタンをクリックするだけです。
56+
GitHubリポジトリのURLを入力し、`ストレージホスト`ドロップダウンからストレージホストを選択して、
57+
`フォルダに移動`ボタンをクリックするだけです。
58+
59+
`フォルダに移動`ボタンをクリックすると、リポジトリ名でストレージフォルダが自動的に作成され、リポジトリの内容をダウンロードして展開するバッチセッションが開始されます。
5660

5761
![](../images/import_github_repository.png)
5862

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

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Jupyter notebook 파일 가져오기 및 실행
99

10-
Jupyter notebook 파일을 가져와서 실행하기 위해서는 notebook 파일에 대한 유효한 URL이 필요합니다. GitHub에 있는 Jupyter notebook을 실행하고자 한다면, 입력 필드에 해당 파일의 URL을 복사해서 붙여넣은 뒤, '가져와서 실행' 버튼을 클릭합니다.
10+
Jupyter notebook 파일을 가져와서 실행하기 위해서는 notebook 파일에 대한 유효한 URL이 필요합니다. GitHub에 있는 Jupyter notebook을 실행하고자 한다면, 입력 필드에 해당 파일의 URL을 복사해서 붙여넣은 뒤, `가져와서 실행` 버튼을 클릭합니다.
1111

1212

1313
:::note
@@ -16,10 +16,12 @@ Jupyter notebook 파일을 가져와서 실행하기 위해서는 notebook 파
1616

1717
![](../images/import_run_notebook.png)
1818

19-
버튼을 클릭하면 대화상자가 나타납니다. 이 대화상자는 세션 페이지나 요약 페이지에서 세션을 시작할 때와 동일한 세션 런처입니다. notebook 가져오기와 새 세션 시작의 차이점은, notebook 가져오기 시 URL에 있는 Jupyter notebook이 자동으로 가져와진다는 것입니다. 나머지는 동일합니다. 필요에 따라 환경과 자원 할당을 설정한 뒤, '시작' 버튼을 클릭합니다.
19+
`가져와서 실행` 버튼을 클릭하면, 기본 설정으로 세션이 바로 생성됩니다. 세션 런처를 수동으로 설정할 필요가 없습니다. 입력한 URL을 통해 notebook 파일이 자동으로 세션에 다운로드됩니다.
20+
21+
환경이나 자원 할당을 직접 설정한 뒤 실행하려면, `가져와서 실행` 버튼 옆의 드롭다운 버튼을 클릭하고 `설정 후 실행`을 선택합니다. 그러면 세션 시작 전에 설정을 조정할 수 있는 전체 세션 런처 페이지가 열립니다.
2022

2123
:::note
22-
'시작' 버튼을 클릭하기 전에 팝업 차단기를 해제해야 실행 중인 notebook 창을 바로 확인할 수 있습니다. 또한, 세션을 실행할 자원이 충분하지 않은 경우 가져온 Jupyter notebook이 실행되지 않습니다.
24+
팝업 차단기를 해제해야 실행 중인 notebook 창을 바로 확인할 수 있습니다. 또한, 세션을 실행할 자원이 충분하지 않은 경우 가져온 Jupyter notebook이 실행되지 않습니다.
2325
:::
2426

2527
![](../images/session_launcher_in_importing_notebook.png)
@@ -30,9 +32,9 @@ Jupyter notebook 파일을 가져와서 실행하기 위해서는 notebook 파
3032

3133
<a id="create-executable-jupyter-notebook-button"></a>
3234

33-
## 실행 가능한 Jupyter notebook 버튼 생성
35+
## 실행 가능한 Jupyter notebook 배지 생성
3436

35-
Jupyter notebook URL에 대한 HTML 또는 Markdown 배지를 생성할 수도 있습니다. 유효한 Jupyter notebook URL을 입력하고 '노트북 배지 코드(HTML)' 또는 '노트북 배지 코드(Markdown)' 복사 버튼을 클릭하면 배지 코드가 클립보드에 복사됩니다. 배지 코드는 notebook으로 세션을 직접 생성하는 링크를 포함합니다. 이 배지 코드를 GitHub 저장소나 HTML 또는 Markdown을 지원하는 곳에 삽입하여 사용할 수 있습니다.
37+
Jupyter notebook URL에 대한 HTML 또는 Markdown 배지를 생성할 수도 있습니다. 유효한 Jupyter notebook URL을 입력하고 `노트북 배지 코드(HTML)` 또는 `노트북 배지 코드(Markdown)` 복사 버튼을 클릭하면 배지 코드가 클립보드에 복사됩니다. 배지 코드는 notebook으로 세션을 직접 생성하는 링크를 포함합니다. 이 배지 코드를 GitHub 저장소나 HTML 또는 Markdown을 지원하는 곳에 삽입하여 사용할 수 있습니다.
3638

3739
:::note
3840
버튼을 클릭하기 전에 계정에 로그인되어 있어야 합니다. 그렇지 않으면 먼저 로그인해야 합니다.
@@ -44,7 +46,9 @@ Jupyter notebook URL에 대한 HTML 또는 Markdown 배지를 생성할 수도
4446

4547
## GitHub 저장소 가져오기
4648

47-
GitHub 저장소 가져오기는 Jupyter notebook 가져오기 및 실행과 유사합니다. GitHub 저장소 URL을 입력하고 '스토리지 호스트' 드롭다운에서 스토리지 호스트를 선택한 뒤 '가져오기' 버튼을 클릭합니다.
49+
GitHub 저장소 가져오기는 Jupyter notebook 가져오기 및 실행과 유사합니다. GitHub 저장소 URL을 입력하고 `스토리지 호스트` 드롭다운에서 스토리지 호스트를 선택한 뒤 `가져오기` 버튼을 클릭합니다.
50+
51+
`가져오기` 버튼을 클릭하면 저장소 이름으로 스토리지 폴더가 자동으로 생성되고, 저장소 내용을 다운로드 및 압축 해제하는 배치 세션이 시작됩니다.
4852

4953
![](../images/import_github_repository.png)
5054

0 commit comments

Comments
 (0)