Skip to content

Commit ce41fa8

Browse files
committed
docs: update import_run page content and apply reviewer fixes
- EN: Fix Title Case headings, backtick button labels, grammar fixes - JA: Translate button labels to Japanese - TH: Translate button labels to Thai - KO: Minor formatting fixes
1 parent 8f2078d commit ce41fa8

4 files changed

Lines changed: 80 additions & 102 deletions

File tree

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
1-
# Import & Run notebooks and web based Git repositories
1+
# Import & Run Notebooks and Web-Based Git Repositories
22

33

4-
On the 'Import & Run' page, Backend.AI supports executing Jupyter notebook files and importing web based Git repositories
4+
On the Import & Run page, Backend.AI supports executing Jupyter notebook files and importing web-based Git repositories
55
such as GitHub and GitLab on the fly. You don't need to create or download into your local storage
66
and re-upload it. The only thing you have to do is input a valid URL you want to execute or import,
77
and click the button on the right side.
88

99
<a id="import-and-run-jupyter-notebooks"></a>
1010

11-
## Import and run Jupyter notebooks
11+
## Import and Run Jupyter Notebooks
1212

13-
To import Jupyter notebooks and run, you need one thing, the valid URL for the notebook file.
14-
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.
13+
To import and run Jupyter notebooks, you need the valid URL for the notebook file.
14+
For example, if you want to execute a Jupyter notebook on GitHub, you can copy and paste
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 which is not starting from localhost.
2020
:::
2121

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

24-
After clicking the button, the dialog appears. This is a session launcher dialog same as
25-
when you starts the session at Sessions page or Summary page. Difference between import notebook
26-
and starting a new session is that import notebook automatically imports Jupyter notebook in the
27-
URL, but simple starting a new session doesn't do that. the rest is same. Click 'LAUNCH' button to
28-
the notebook after setting the environments and resource allocation as needed.
24+
After clicking the button, the session launcher dialog appears. This is the same dialog as
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.
2928

3029
:::note
31-
The pop-up blocker must be turned off before clicking 'LAUNCH' button to immediately
30+
The pop-up blocker must be turned off before clicking the `Launch` button to immediately
3231
see the running notebook window. Also, if there's not enough resources to execute the session,
3332
imported Jupyter notebook will not run.
3433
:::
@@ -41,15 +40,16 @@ You can see the importing operation is successfully completed in Sessions page.
4140

4241
<a id="create-executable-jupyter-notebook-button"></a>
4342

44-
## Create executable Jupyter notebook button
43+
## Create Executable Jupyter Notebook Badge
4544

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.
45+
You can also create an HTML or Markdown badge for a Jupyter notebook URL.
46+
Input a valid Jupyter notebook URL and click the `Notebook Badge Code (HTML)` or
47+
`Notebook Badge Code (Markdown)` copy button to copy the badge code to your clipboard.
48+
The badge code creates a link that directly opens a session with the notebook.
49+
You can use the badge code by inserting it in GitHub repositories or anywhere that supports HTML or Markdown.
5050

5151
:::note
52-
your account must be logined before clicking the button. Otherwise, you have to login first.
52+
Your account must be logged in before clicking the button. Otherwise, you have to log in first.
5353
:::
5454

5555
![](../images/create_notebook_button.png)
@@ -58,9 +58,9 @@ your account must be logined before clicking the button. Otherwise, you have to
5858

5959
## Importing GitHub Repositories
6060

61-
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.
61+
Importing a GitHub repository is similar to importing and running a Jupyter notebook.
62+
All you have to do is fill in the GitHub repository URL, select a storage host from the
63+
`Storage Host` dropdown, and click the `Get To Folder` button.
6464

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

@@ -70,7 +70,7 @@ the limit, then importing repository will fail. Please check resource
7070
statistics panel and Data & Storage page before importing the repository.
7171
:::
7272

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

7676
![](../images/import_github_repository_result.png)
@@ -86,6 +86,6 @@ but you need to explicitly set the branch name to import.
8686
![](../images/import_gitlab_repository.png)
8787

8888
:::note
89-
If there's data folder that has the same name already, the system will append
89+
If there's a storage folder that has the same name already, the system will append
9090
`_` (underscore) and number in the imported repository folder.
9191
:::
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ノートブックが自動的にインポートされることです。残りは同じです。必要に応じて環境とリソース配分を設定した後、「ローンチ」ボタンをクリックします。
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+
「ローンチ」ボタンをクリックする前に、ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされた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/ko/import_run/import_run.md

Lines changed: 5 additions & 5 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
@@ -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을 입력하고 '노트북 배지 코드(HTML)' 또는 '노트북 배지 코드(Markdown)' 복사 버튼을 클릭하면 배지 코드가 클립보드에 복사됩니다. 배지 코드는 notebook으로 세션을 직접 생성하는 링크를 포함합니다. 이 배지 코드를 GitHub 저장소나 HTML 또는 Markdown을 지원하는 곳에 삽입하여 사용할 수 있습니다.
3636

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

4545
## GitHub 저장소 가져오기
4646

47-
GitHub 저장소 가져오기는 Jupyter notebook 가져오기 및 실행과 유사합니다. GitHub 저장소 URL을 입력하고 '가져오기' 버튼을 클릭하기만 하면 됩니다. 두 개 이상의 스토리지 호스트에 접근할 수 있는 경우, 목록에서 하나를 선택할 수 있습니다.
47+
GitHub 저장소 가져오기는 Jupyter notebook 가져오기 및 실행과 유사합니다. GitHub 저장소 URL을 입력하고 '스토리지 호스트' 드롭다운에서 스토리지 호스트를 선택한 뒤 '가져오기' 버튼을 클릭합니다.
4848

4949
![](../images/import_github_repository.png)
5050

5151
:::note
5252
세션을 시작할 자원이 충분하지 않거나 폴더 수가 한도에 도달한 경우, 저장소 가져오기가 실패합니다. 저장소를 가져오기 전에 자원 통계 패널과 데이터 & 스토리지 페이지를 확인해 주십시오.
5353
:::
5454

55-
저장소가 해당 이름의 데이터 폴더로 성공적으로 가져와진 것을 확인할 수 있습니다.
55+
저장소가 해당 이름의 스토리지 폴더로 성공적으로 가져와진 것을 확인할 수 있습니다.
5656

5757
![](../images/import_github_repository_result.png)
5858

@@ -65,5 +65,5 @@ GitHub 저장소 가져오기는 Jupyter notebook 가져오기 및 실행과 유
6565
![](../images/import_gitlab_repository.png)
6666

6767
:::note
68-
동일한 이름의 데이터 폴더가 이미 존재하는 경우, 시스템은 가져온 저장소 폴더 이름에 `_`(밑줄)와 숫자를 추가합니다.
68+
동일한 이름의 스토리지 폴더가 이미 존재하는 경우, 시스템은 가져온 저장소 폴더 이름에 `_`(밑줄)와 숫자를 추가합니다.
6969
:::

0 commit comments

Comments
 (0)