Skip to content

Commit 5b9a0a9

Browse files
committed
docs: add TODO screenshots and fix card titles in start page
1 parent ffa4ab3 commit 5b9a0a9

4 files changed

Lines changed: 86 additions & 37 deletions

File tree

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@ external URLs.
1010
## Announcement Banner
1111

1212
If your system administrator has published an announcement, it appears as a
13-
banner at the top of the Start page. You can dismiss the banner by clicking the
14-
close icon. The announcement supports Markdown formatting and may contain
15-
important notices about system maintenance, updates, or usage guidelines.
13+
banner at the top of the Start page. The announcement supports Markdown
14+
formatting and may contain important notices about system maintenance, updates,
15+
or usage guidelines. You can dismiss the banner by clicking the close icon.
16+
17+
![](../images/start_announcement_banner.png)
18+
<!-- TODO: Capture screenshot of the announcement banner with sample content -->
1619

1720
## Action Cards
1821

@@ -21,8 +24,8 @@ The Start page displays the following action cards by default:
2124
- **Create New Storage Folder**: Create a storage folder and upload files. This
2225
is an essential first step for training models or providing external services.
2326
Clicking the button opens the folder creation dialog.
24-
- **Start Interactive Session**: Create an interactive session to train a model.
25-
Choose your preferred environment and resources to run your code.
27+
- **Start Interactive Session**: Create a session to train a model. Choose your
28+
preferred environment and resources to run your code.
2629
- **Start Batch Session**: Create a batch session for predefined files or
2730
scheduled tasks. Enter the command, set the date and time, and run the session
2831
on demand.
@@ -40,10 +43,13 @@ system administrator.
4043
## Start From URL
4144

4245
The **Start From URL** card allows you to import and run projects directly from
43-
external sources. Clicking the card opens a dialog with three tabs:
46+
external sources. Clicking the card opens a dialog with three tabs.
4447

4548
### Import Notebook
4649

50+
![](../images/start_from_url_notebook.png)
51+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import Notebook tab -->
52+
4753
1. Enter a Jupyter Notebook URL (must end with `.ipynb`) in the **Notebook URL**
4854
field
4955
2. Click **Import & Run** to automatically create a session and open the
@@ -58,6 +64,9 @@ project documentation.
5864

5965
### Import GitHub Repository
6066

67+
![](../images/start_from_url_github.png)
68+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitHub Repository tab -->
69+
6170
1. Enter a valid GitHub repository URL in the **GitHub URL** field
6271
2. Select a **Storage Host** where the repository will be saved
6372
3. Optionally set the **Folder Usage Mode** (General or Models)
@@ -68,6 +77,9 @@ when starting a session.
6877

6978
### Import GitLab Repository
7079

80+
![](../images/start_from_url_gitlab.png)
81+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitLab Repository tab -->
82+
7183
1. Enter a valid GitLab repository URL in the **GitLab URL** field
7284
2. Optionally specify a **GitLab Branch Name** (defaults to `master`)
7385
3. Select a **Storage Host** where the repository will be saved

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

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,26 @@
1010
## お知らせバナー
1111

1212
システム管理者がお知らせを公開している場合、スタートページの上部にバナーが
13-
表示されます。閉じるアイコンをクリックしてバナーを閉じることができます。
14-
お知らせはMarkdown形式をサポートしており、システムメンテナンス、アップデート、
15-
利用ガイドラインなどの重要な通知が含まれる場合があります。
13+
表示されます。お知らせはMarkdown形式をサポートしており、システムメンテナンス、
14+
アップデート、利用ガイドラインなどの重要な通知が含まれる場合があります。
15+
閉じるアイコンをクリックしてバナーを閉じることができます。
16+
17+
![](../images/start_announcement_banner.png)
18+
<!-- TODO: Capture screenshot of the announcement banner with sample content -->
1619

1720
## アクションカード
1821

1922
スタートページにはデフォルトで以下のアクションカードが表示されます:
2023

21-
- **新しいストレージフォルダを作成**: ストレージフォルダを作成してファイルを
22-
アップロードします。モデルの学習や外部サービス提供の準備に必要な最初の
23-
ステップです。ボタンをクリックするとフォルダ作成ダイアログが開きます。
24-
- **インタラクティブセッション開始**: モデル学習のためのインタラクティブセッションを
25-
作成します。必要な環境とリソースを選択してコードを実行できます。
24+
- **保存フォルダー作成**: ストレージフォルダを作成してファイルをアップロード
25+
します。モデルの学習や外部サービス提供の準備に必要な最初のステップです。
26+
ボタンをクリックするとフォルダ作成ダイアログが開きます。
27+
- **インタラクティブセッション開始**: モデル学習のためのセッションを作成します。
28+
必要な環境とリソースを選択してコードを実行できます。
2629
- **バッチセッション開始**: 準備済みのファイルやスケジュールされたタスクのための
2730
バッチセッションを作成します。コマンドを入力し、日時を設定して実行します。
28-
- **モデルサービス開始**: 学習済みモデルを他のユーザーと共有するためのモデルサービス
29-
エンドポイントを作成します
31+
- **モデルサービス開始**: 学習済みモデルを他のユーザーと共有するためのモデル
32+
サービスエンドポイントを作成します
3033
- **URLから開始**: GitHub、GitLab、Jupyter NotebookなどのさまざまなURL環境から
3134
プロジェクトとコードをインポートします。
3235

@@ -43,6 +46,9 @@
4346

4447
### ノートブック取り込み
4548

49+
![](../images/start_from_url_notebook.png)
50+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import Notebook tab -->
51+
4652
1. **ノートブックのURL**フィールドにJupyter Notebook URL(`.ipynb`で終わる)を
4753
入力します
4854
2. **インポート & 実行**をクリックすると、自動的にセッションが作成され、Jupyterで
@@ -57,21 +63,29 @@ Markdownのバッジコードをコピーして、プロジェクトのドキュ
5763

5864
### GitHubリポジトリをインポートする
5965

66+
![](../images/start_from_url_github.png)
67+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitHub Repository tab -->
68+
6069
1. **GitHubのURL**フィールドに有効なGitHubリポジトリURLを入力します
6170
2. リポジトリを保存する**ストレージホスト**を選択します
6271
3. 必要に応じて**フォルダ利用モード**(一般またはモデル)を設定します
63-
4. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローンします
72+
4. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローン
73+
します
6474

6575
インポートされたリポジトリはストレージフォルダに変換され、セッション開始時に
6676
マウントできます。
6777

6878
### GitLabリポジトリ取り込み
6979

80+
![](../images/start_from_url_gitlab.png)
81+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitLab Repository tab -->
82+
7083
1. **GitLabアドレス**フィールドに有効なGitLabリポジトリURLを入力します
7184
2. 必要に応じて**GitLab ブランチ名**を指定します(デフォルト: `master`
7285
3. リポジトリを保存する**ストレージホスト**を選択します
7386
4. 必要に応じて**フォルダ利用モード**(一般またはモデル)を設定します
74-
5. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローンします
87+
5. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローン
88+
します
7589

7690
## カードレイアウトのカスタマイズ
7791

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

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,44 @@
99
## 공지사항 배너
1010

1111
시스템 관리자가 공지사항을 게시한 경우, 시작 페이지 상단에 배너가 표시됩니다.
12-
닫기 아이콘을 클릭하여 배너를 닫을 수 있습니다. 공지사항은 Markdown 형식을
13-
지원하며, 시스템 유지보수, 업데이트, 사용 가이드라인 등 중요한 안내를 포함할 수
14-
있습니다.
12+
공지사항은 Markdown 형식을 지원하며, 시스템 유지보수, 업데이트, 사용 가이드라인 등
13+
중요한 안내를 포함할 수 있습니다. 닫기 아이콘을 클릭하여 배너를 닫을 수 있습니다.
14+
15+
![](../images/start_announcement_banner.png)
16+
<!-- TODO: Capture screenshot of the announcement banner with sample content -->
1517

1618
## 액션 카드
1719

1820
시작 페이지에는 기본적으로 다음 액션 카드가 표시됩니다:
1921

20-
- **새 스토리지 폴더 생성**: 스토리지 폴더를 생성하고 파일을 업로드합니다. 모델을
21-
학습시키거나 외부 서비스를 제공하기 위한 필수적인 첫 단계입니다. 버튼을 클릭하면
22-
폴더 생성 대화상자가 열립니다.
23-
- **Interactive 세션 생성**: 모델을 학습시킬 대화형 세션을 생성합니다. 원하는
24-
환경과 리소스를 선택하여 코드를 실행할 수 있습니다.
22+
- **새 스토리지 폴더 생성하기**: 스토리지 폴더를 생성하고 파일을 업로드합니다.
23+
모델을 학습시키거나 외부 서비스를 제공하기 위한 필수적인 첫 단계입니다. 버튼을
24+
클릭하면 폴더 생성 대화상자가 열립니다.
25+
- **Interactive 세션 생성**: 모델을 학습시킬 세션을 생성합니다. 원하는 환경과
26+
리소스를 선택하여 코드를 실행할 수 있습니다.
2527
- **Batch 세션 생성**: 미리 정의된 파일 또는 예약된 작업을 위한 배치 세션을
2628
생성합니다. 명령을 입력하고 날짜와 시간을 설정한 다음 필요에 따라 세션을
2729
실행합니다.
2830
- **모델 서비스 시작**: 학습이 끝난 모델을 다른 사람과 공유하기 위해 모델 서비스
2931
엔드포인트를 생성합니다.
30-
- **URL로 시작**: GitHub, GitLab, Jupyter Notebook 등 다양한 환경에서 URL을 통해
32+
- **URL 로 시작**: GitHub, GitLab, Jupyter Notebook 등 다양한 환경에서 URL을 통해
3133
프로젝트와 코드를 가져올 수 있습니다.
3234

3335
:::note
3436
서버 설치 및 설정 환경에 따라, 모델 서비스 카드 등 일부 카드가 비활성화되어 있을
3537
수 있습니다. 해당 기능의 사용을 원하시는 경우, 시스템 관리자에게 문의하십시오.
3638
:::
3739

38-
## URL로 시작
40+
## URL 로 시작
3941

40-
**URL로 시작** 카드를 사용하면 외부 소스에서 프로젝트를 가져와 바로 실행할 수
42+
**URL 로 시작** 카드를 사용하면 외부 소스에서 프로젝트를 가져와 바로 실행할 수
4143
있습니다. 카드를 클릭하면 세 개의 탭이 있는 대화상자가 열립니다.
4244

4345
### 노트북 가져오기
4446

47+
![](../images/start_from_url_notebook.png)
48+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import Notebook tab -->
49+
4550
1. **가져올 노트북 URL** 필드에 Jupyter Notebook URL(`.ipynb`으로 끝나는)을
4651
입력합니다
4752
2. **가져와서 실행** 버튼을 클릭하면 자동으로 세션이 생성되고 Jupyter에서
@@ -56,19 +61,25 @@ Markdown 뱃지 코드를 복사하여 프로젝트 문서에 바로 실행 링
5661

5762
### GitHub 저장소 가져오기
5863

64+
![](../images/start_from_url_github.png)
65+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitHub Repository tab -->
66+
5967
1. **GitHub 주소** 필드에 유효한 GitHub 저장소 URL을 입력합니다
6068
2. 저장소가 저장될 **스토리지 호스트**를 선택합니다
61-
3. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
69+
3. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
6270
4. **가져오기** 버튼을 클릭하여 저장소를 새 스토리지 폴더로 복제합니다
6371

6472
가져온 저장소는 스토리지 폴더로 변환되며, 세션 시작 시 마운트할 수 있습니다.
6573

6674
### GitLab 저장소 가져오기
6775

76+
![](../images/start_from_url_gitlab.png)
77+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitLab Repository tab -->
78+
6879
1. **GitLab 주소** 필드에 유효한 GitLab 저장소 URL을 입력합니다
6980
2. 필요한 경우 **GitLab 브랜치 이름**을 지정합니다 (기본값: `master`)
7081
3. 저장소가 저장될 **스토리지 호스트**를 선택합니다
71-
4. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
82+
4. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
7283
5. **가져오기** 버튼을 클릭하여 저장소를 새 스토리지 폴더로 복제합니다
7384

7485
## 카드 레이아웃 커스터마이즈

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,22 @@
1010
## แบนเนอร์ประกาศ
1111

1212
หากผู้ดูแลระบบได้เผยแพร่ประกาศ จะมีแบนเนอร์แสดงที่ด้านบนของหน้าเริ่มต้น
13-
คุณสามารถปิดแบนเนอร์ได้โดยคลิกไอคอนปิด ประกาศรองรับรูปแบบ Markdown
14-
และอาจมีการแจ้งเตือนที่สำคัญเกี่ยวกับการบำรุงรักษาระบบ การอัปเดต หรือ
15-
แนวทางการใช้งาน
13+
ประกาศรองรับรูปแบบ Markdown และอาจมีการแจ้งเตือนที่สำคัญเกี่ยวกับ
14+
การบำรุงรักษาระบบ การอัปเดต หรือแนวทางการใช้งาน คุณสามารถปิดแบนเนอร์ได้
15+
โดยคลิกไอคอนปิด
16+
17+
![](../images/start_announcement_banner.png)
18+
<!-- TODO: Capture screenshot of the announcement banner with sample content -->
1619

1720
## การ์ดการดำเนินการ
1821

1922
หน้าเริ่มต้นแสดงการ์ดการดำเนินการต่อไปนี้ตามค่าเริ่มต้น:
2023

21-
- **สร้างโฟลเดอร์จัดเก็บใหม่**: สร้างโฟลเดอร์จัดเก็บและอัปโหลดไฟล์
24+
- **สร้างโฟลเดอร์จัดเก็บข้อมูลใหม่**: สร้างโฟลเดอร์จัดเก็บและอัปโหลดไฟล์
2225
นี่เป็นขั้นตอนแรกที่จำเป็นสำหรับการฝึกโมเดลหรือการให้บริการภายนอก
2326
การคลิกปุ่มจะเปิดกล่องโต้ตอบการสร้างโฟลเดอร์
24-
- **เริ่มเซสชันแบบโต้ตอบ**: สร้างเซสชันแบบโต้ตอบเพื่อฝึกโมเดล เลือก
25-
สภาพแวดล้อมและทรัพยากรที่ต้องการสำหรับการรันโค้ด
27+
- **เริ่มเซสชันแบบโต้ตอบ**: สร้างเซสชันเพื่อฝึกโมเดล เลือกสภาพแวดล้อมและ
28+
ทรัพยากรที่ต้องการสำหรับการรันโค้ด
2629
- **เริ่มเซสชันแบทช์**: สร้างเซสชันแบทช์สำหรับไฟล์ที่กำหนดไว้ล่วงหน้า
2730
หรืองานที่กำหนดเวลาไว้ ป้อนคำสั่ง ตั้งค่าวันที่และเวลา และรันตามต้องการ
2831
- **เริ่มบริการโมเดล**: สร้าง endpoint บริการโมเดลเพื่อแชร์โมเดลที่ผ่าน
@@ -42,6 +45,9 @@
4245

4346
### นำเข้าโน้ตบุ๊ก
4447

48+
![](../images/start_from_url_notebook.png)
49+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import Notebook tab -->
50+
4551
1. ป้อน URL ของ Jupyter Notebook (ต้องลงท้ายด้วย `.ipynb`) ในฟิลด์
4652
**URL โน้ตบุ๊ก**
4753
2. คลิก **นำเข้าและรัน** เพื่อสร้างเซสชันอัตโนมัติและเปิดโน้ตบุ๊กใน Jupyter
@@ -54,6 +60,9 @@
5460

5561
### นำเข้าพื้นที่เก็บข้อมูล GitHub
5662

63+
![](../images/start_from_url_github.png)
64+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitHub Repository tab -->
65+
5766
1. ป้อน URL พื้นที่เก็บข้อมูล GitHub ที่ถูกต้องในฟิลด์ **URL GitHub**
5867
2. เลือก **โฮสต์ที่เก็บข้อมูล** ที่จะบันทึกพื้นที่เก็บข้อมูล
5968
3. ตั้งค่า **โหมดการใช้งานโฟลเดอร์** (ทั่วไปหรือโมเดล) ตามต้องการ
@@ -65,6 +74,9 @@
6574

6675
### นำเข้าพื้นที่เก็บข้อมูล GitLab
6776

77+
![](../images/start_from_url_gitlab.png)
78+
<!-- TODO: Capture screenshot of the Start From URL modal showing the Import GitLab Repository tab -->
79+
6880
1. ป้อน URL พื้นที่เก็บข้อมูล GitLab ที่ถูกต้องในฟิลด์ **URL GitLab**
6981
2. ระบุ **ชื่อ Branch GitLab** ตามต้องการ (ค่าเริ่มต้น: `master`)
7082
3. เลือก **โฮสต์ที่เก็บข้อมูล** ที่จะบันทึกพื้นที่เก็บข้อมูล

0 commit comments

Comments
 (0)