Skip to content

Commit 0a4de8a

Browse files
committed
docs: replace data folder with storage folder in JA/TH, add Title Case and bold fields
1 parent 6a289b0 commit 0a4de8a

4 files changed

Lines changed: 50 additions & 50 deletions

File tree

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

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ to the [Quota Setting Panel](#quota-setting-panel) section.
4545
<a id="create-storage-folder"></a>
4646
<a id="create_storage_folder"></a>
4747

48-
## Create storage folder
48+
## Create Storage Folder
4949

5050

5151
To create a new folder, click 'Create Folder' on the Data page. Fill in the fields in
@@ -55,18 +55,18 @@ the creation dialog as follows:
5555

5656
The meaning of each field in the creation dialog is as follows.
5757

58-
- Usage Mode: Set the purpose of the folder.
58+
- **Usage Mode**: Set the purpose of the folder.
5959

6060
* General: Defines a folder for storing various data in a general-purpose manner.
6161
* Models: Defines a folder specialized for model serving and management. If this mode is selected, it is also possible to toggle the folder's copy availability.
6262
* Auto Mount: Folders automatically mounted when a session is created. If selected, the folder name must start with a dot ('.').
6363

64-
- Folder name: The name of the folder (up to 64 characters).
65-
- Location: Select the NFS host where the folder will be created. If there are multiple hosts, choose one. An indicator will show if there is enough available space.
66-
- Type: Determines the type of folder to be created. It can be set as User or Project. The User folder is a folder that users can create and use alone and the Project folder is a folder created by admin and shared by users in the project.
67-
- Project: Shown only when you select project type. Designates the project to which the folder belongs when creating a new project folder. Project folders must belong to a project. However, it does not play any role when creating a user folder.
68-
- Permission: Set permission of a project folder for project members. If this is set to "Read only", project members cannot write to this folder inside their compute session.
69-
- Cloneable: Shown only when you select usage model to "Model". Select whether the vfolder you are creating should be cloneable.
64+
- **Folder name**: The name of the folder (up to 64 characters).
65+
- **Location**: Select the NFS host where the folder will be created. If there are multiple hosts, choose one. An indicator will show if there is enough available space.
66+
- **Type**: Determines the type of folder to be created. It can be set as User or Project. The User folder is a folder that users can create and use alone and the Project folder is a folder created by admin and shared by users in the project.
67+
- **Project**: Shown only when you select project type. Designates the project to which the folder belongs when creating a new project folder. Project folders must belong to a project. However, it does not play any role when creating a user folder.
68+
- **Permission**: Set permission of a project folder for project members. If this is set to "Read only", project members cannot write to this folder inside their compute session.
69+
- **Cloneable**: Shown only when you select usage model to "Model". Select whether the vfolder you are creating should be cloneable.
7070

7171
The folders created here can be [mounted](../mount_vfolder/mount_vfolder.md#session-mounts) when creating a compute session. Folders are mounted
7272
under the user's default working directory, `/home/work/`, and the file stored in the mounted
@@ -75,7 +75,7 @@ directory will not be deleted when the compute session is terminated.
7575

7676
<a id="explore-folder"></a>
7777

78-
## Explore folder
78+
## Explore Folder
7979

8080

8181
Click the folder name to open a file explorer and view the contents of the folder.
@@ -124,7 +124,7 @@ The editor supports both light and dark themes matching your UI preferences. You
124124
The Edit File button is only available when you have write_content permission on the storage folder. If the file fails to load, an error message will be displayed.
125125
:::
126126

127-
## Rename folder
127+
## Rename Folder
128128

129129

130130
If you have permission to rename the storage folder, you can rename it by
@@ -133,7 +133,7 @@ clicking the edit button.
133133
![](../images/rename_vfolder.png)
134134

135135

136-
## Delete folder
136+
## Delete Folder
137137

138138

139139
If you have permission to delete the storage folder, you can send the folder to the 'Trash'
@@ -173,7 +173,7 @@ You can access FileBrowser in two ways.
173173
- Launch a compute session directly from a FileBrowser image on Sessions page.
174174

175175

176-
### Execute FileBrowser from folder explorer dialog
176+
### Execute FileBrowser From Folder Explorer Dialog
177177

178178
Go to the Data page and open the file explorer dialog of target
179179
storage folder. Click the folder name to open the file explorer.
@@ -211,7 +211,7 @@ explorer, a new compute session will be created and a total of two
211211
FileBrowser sessions will appear.
212212
:::
213213

214-
### Create a compute session with FileBrowser image
214+
### Create a Compute Session With FileBrowser Image
215215

216216
You can directly create a compute session with FileBrowser supported images.
217217
You need to mount at least one or more storage folders to access them. You can use
@@ -224,7 +224,7 @@ The root directory of FileBrowser will be `/home/work`. Therefore, you
224224
can access any mounted storage folders for the compute session.
225225
:::
226226

227-
### Basic usage examples of FileBrowser
227+
### Basic Usage Examples of FileBrowser
228228

229229
Here, we present some basic usage examples of FileBrowser in Backend.AI. Most
230230
of the FileBrowser operations are intuitive, but if you need more detailed
@@ -305,7 +305,7 @@ Depending on the system settings, running SFTP server from the file dialog may n
305305
be allowed.
306306
:::
307307

308-
### Execute SFTP server from folder explorer dialog in Data page
308+
### Execute SFTP Server From Folder Explorer Dialog in Data Page
309309

310310
Go to the Data page and open the file explorer dialog of target storage folder.
311311
Click the folder button or the folder name to open the file explorer.
@@ -337,15 +337,15 @@ want to connect via SSH to your container. Please refer to
337337
## Folder Categories
338338

339339

340-
## Pipeline folders
340+
## Pipeline Folders
341341

342342
This tab shows the list of folders that are automatically created when executing a
343343
pipeline in FastTrack. When a pipeline is created, a new folder is created and mounted
344344
under `/pipeline` for each instance of work (computing session).
345345

346346
<a id="automount-folder"></a>
347347

348-
## Automount folders
348+
## Automount Folders
349349

350350

351351
Data page has an Automount Folders tab. Click this tab to see a

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,18 @@ the creation dialog as follows:
5353

5454
The meaning of each field in the creation dialog is as follows.
5555

56-
- Usage Mode: Set the purpose of the folder.
56+
- **Usage Mode**: Set the purpose of the folder.
5757

5858
* General: Defines a folder for storing various data in a general-purpose manner.
5959
* モデル一覧: Defines a folder specialized for model serving and management. If this mode is selected, it is also possible to toggle the folder's copy availability.
6060
* Auto Mount: フォルダー automatically mounted when a session is created. If selected, the folder name must start with a dot ('.').
6161

62-
- Folder name: The name of the folder (up to 64 characters).
63-
- Location: Select the NFS host where the folder will be created. If there are multiple hosts, choose one. An indicator will show if there is enough available space.
64-
- 種類: 作成するフォルダーの種類を決定します。ユーザーまたはプロジェクトとして設定できます。ユーザーフォルダーは、ユーザーが自身で作成して使用できるフォルダーであり、プロジェクトフォルダーは管理者によって作成され、プロジェクト内のユーザーと共有されるフォルダーです。
65-
- プロジェクト:プロジェクトタイプを選択したときにのみ表示されます。新しいプロジェクトフォルダを作成するときに、フォルダが属するプロジェクトを指定します。プロジェクトフォルダは、プロジェクトに属する必要があります。ただし、ユーザーフォルダを作成する際には、役割を果たしません。
66-
- パーミッション: プロジェクトフォルダのプロジェクトメンバーに対するパーミッションを設定します。「読み取り専用」に設定されている場合、プロジェクトメンバーはコンピュートセッション内でこのフォルダに書き込みを行うことができません。
67-
- Cloneable: Shown only when you select usage model to "Model". Select whether the vfolder you are creating should be cloneable.
62+
- **Folder name**: The name of the folder (up to 64 characters).
63+
- **Location**: Select the NFS host where the folder will be created. If there are multiple hosts, choose one. An indicator will show if there is enough available space.
64+
- **種類**: 作成するフォルダーの種類を決定します。ユーザーまたはプロジェクトとして設定できます。ユーザーフォルダーは、ユーザーが自身で作成して使用できるフォルダーであり、プロジェクトフォルダーは管理者によって作成され、プロジェクト内のユーザーと共有されるフォルダーです。
65+
- **プロジェクト**:プロジェクトタイプを選択したときにのみ表示されます。新しいプロジェクトフォルダを作成するときに、フォルダが属するプロジェクトを指定します。プロジェクトフォルダは、プロジェクトに属する必要があります。ただし、ユーザーフォルダを作成する際には、役割を果たしません。
66+
- **パーミッション**: プロジェクトフォルダのプロジェクトメンバーに対するパーミッションを設定します。「読み取り専用」に設定されている場合、プロジェクトメンバーはコンピュートセッション内でこのフォルダに書き込みを行うことができません。
67+
- **Cloneable**: Shown only when you select usage model to "Model". Select whether the vfolder you are creating should be cloneable.
6868

6969
The folders created here can be [mounted](../mount_vfolder/mount_vfolder.md#session-mounts) when creating a compute session. フォルダー are mounted
7070
under the ユーザー's default working directory, `/home/work/`, and the file stored in the mounted
@@ -151,14 +151,14 @@ the ユーザー's local machine.
151151

152152
ファイルブラウザには2つの方法でアクセスできます。
153153

154-
- Execute FileBrowser from file explorer dialog of a data folder.
154+
- Execute FileBrowser from file explorer dialog of a storage folder.
155155
- セッションページのFileBrowserイメージから直接コンピュートセッションを起動します。
156156

157157

158158
### Execute FileBrowser from folder explorer dialog
159159

160160
Go to the Data page and open the file explorer dialog of target
161-
data folder. Click the folder name to open the file explorer.
161+
storage folder. Click the folder name to open the file explorer.
162162

163163
![](../images/click_folder_name.png)
164164

@@ -190,7 +190,7 @@ FileBrowser対応のイメージを使用して直接コンピュートセッシ
190190

191191
:::note
192192
The root directory of FileBrowser will be `/home/work`. Therefore, you
193-
can access any mounted data folders for the compute session.
193+
can access any mounted storage folders for the compute session.
194194
:::
195195

196196
### FileBrowserの基本的な使用例
@@ -229,7 +229,7 @@ You can also upload local files and directories by drag and drop.
229229

230230
**Move files or directories to another directory**
231231

232-
Moving files or directories in data folder is also possible from FileBrowser.
232+
Moving files or directories in storage folder is also possible from FileBrowser.
233233
You can move files or directories by following steps below.
234234

235235
1. Select directories or files from FileBrowser.
@@ -272,7 +272,7 @@ be allowed.
272272

273273
### Execute SFTP server from folder explorer dialog in Data page
274274

275-
Go to the Data page and open the file explorer dialog of target data folder.
275+
Go to the Data page and open the file explorer dialog of target storage folder.
276276
Click the folder button or the folder name to open the file explorer.
277277

278278
Click 'Run SFTP server' button in the upper-right corner of the explorer.
@@ -288,7 +288,7 @@ For the connection, click 'Download SSH Key' button to download the SSH private
288288
(`id_container`). Also, remember the host and port number. Then, you can copy your
289289
files to the session using the Connection Example code written in the dialog, or
290290
referring to the following guide: [SFTP Connection Guide](../sftp_to_container/sftp_to_container.md#for-linux-mac).
291-
To preserve the files, you need to transfer the files to the data folder. Also,
291+
To preserve the files, you need to transfer the files to the storage folder. Also,
292292
the session will be terminated when there is no transfer for some time.
293293

294294

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,18 +45,18 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용
4545

4646
생성 대화 상자의 각 필드 의미는 다음과 같습니다.
4747

48-
- 사용 방식: 폴더의 용도를 설정합니다.
48+
- **사용 방식**: 폴더의 용도를 설정합니다.
4949

5050
* 일반: 다양한 데이터를 범용 목적으로 저장하는 폴더입니다.
5151
* 모델: 모델 서빙 및 관리에 특화된 폴더입니다. 이 모드를 선택하면 폴더 복제 가능 여부를 설정할 수 있습니다.
5252
* 자동 마운트(Auto Mount): 연산 세션을 만들 때 자동으로 마운트되는 폴더입니다. 이름은 반드시 점('.')으로 시작해야 합니다.
5353

54-
- 폴더 이름: 폴더명을 입력합니다 (최대 64자).
55-
- 위치: 폴더를 생성할 NFS 호스트를 선택합니다. 여러 호스트가 있을 경우 각각의 사용 가능 용량을 확인한 후 적절한 호스트를 선택하세요.
56-
- 종류: 생성할 폴더 유형을 결정합니다. 사용자(User) 또는 프로젝트(Project)로 설정할 수 있습니다. 사용자 폴더는 사용자가 단독으로 생성하여 사용할 수 있는 폴더이며, 프로젝트 폴더는 관리자가 생성하고 프로젝트의 사용자가 공유하는 폴더입니다.
57-
- 프로젝트: 프로젝트 타입을 선택한 경우에만 표시됩니다. 새 프로젝트 폴더를 만들 때 폴더가 속한 프로젝트를 지정할 수 있습니다. 프로젝트 폴더는 반드시 프로젝트에 속해야 하지만, 사용자 폴더를 생성할 때에는 별도의 역할을 수행하지 않습니다.
58-
- 권한: 프로젝트 멤버에 대한 프로젝트 폴더의 권한을 설정합니다. "읽기 전용"으로 설정된 경우, 프로젝트 멤버가 연산 세션 내에서 이 폴더에 쓰기 작업을 수행할 수 없습니다.
59-
- 복제 가능 여부: 사용 방식이 "모델"로 설정된 경우에만 표시됩니다. 생성하는 가상 폴더(vfolder)가 복제 가능한지 여부를 선택합니다.
54+
- **폴더 이름**: 폴더명을 입력합니다 (최대 64자).
55+
- **위치**: 폴더를 생성할 NFS 호스트를 선택합니다. 여러 호스트가 있을 경우 각각의 사용 가능 용량을 확인한 후 적절한 호스트를 선택하세요.
56+
- **종류**: 생성할 폴더 유형을 결정합니다. 사용자(User) 또는 프로젝트(Project)로 설정할 수 있습니다. 사용자 폴더는 사용자가 단독으로 생성하여 사용할 수 있는 폴더이며, 프로젝트 폴더는 관리자가 생성하고 프로젝트의 사용자가 공유하는 폴더입니다.
57+
- **프로젝트**: 프로젝트 타입을 선택한 경우에만 표시됩니다. 새 프로젝트 폴더를 만들 때 폴더가 속한 프로젝트를 지정할 수 있습니다. 프로젝트 폴더는 반드시 프로젝트에 속해야 하지만, 사용자 폴더를 생성할 때에는 별도의 역할을 수행하지 않습니다.
58+
- **권한**: 프로젝트 멤버에 대한 프로젝트 폴더의 권한을 설정합니다. "읽기 전용"으로 설정된 경우, 프로젝트 멤버가 연산 세션 내에서 이 폴더에 쓰기 작업을 수행할 수 없습니다.
59+
- **복제 가능 여부**: 사용 방식이 "모델"로 설정된 경우에만 표시됩니다. 생성하는 가상 폴더(vfolder)가 복제 가능한지 여부를 선택합니다.
6060

6161
여기서 생성한 폴더는 연산 세션 생성 시 [마운트](../mount_vfolder/mount_vfolder.md#session-mounts)할 수 있습니다. 폴더는 사용자의 기본 작업 디렉토리인 `/home/work/` 아래에 마운트되며, 마운트된 디렉토리에 저장된 파일은 연산 세션이 종료되어도 삭제되지 않습니다.
6262
(폴더를 삭제하면 파일도 함께 삭제됩니다.)

0 commit comments

Comments
 (0)