Skip to content

Commit 9ff7773

Browse files
yomybabyagatha197
authored andcommitted
docs(vfolder): document upload-permission gating, invitation entry point, and cascading delete warning
Part of the recent main-branch docs catch-up plan (Work Item 7). Source PRs: - FR-2893 (#7412) disable Upload button when host lacks upload-file permission - FR-2817 (#7261) unclip folder-status invitation badge; /data invitation entry point - FR-2813 (#7260) folder-create notification with VFolder node card - FR-2845 (#7339) cascading model card deletion warning when associated vfolder deleted - FR-2622 family (#6881, #6883, #7135, #7250) delete-folder option + trash notification on model card deletion - FR-2651 (#6888) list all model-store folders when creating a model card Changes: - New H3 "Invitation Badge and Entry Point" — unclipped pending-invitation badge on the Data entry; /data itself usable for invitation review. - Explore Folder: :::warning explains Upload button + drag-and-drop are disabled when the keypair resource policy denies upload-file on the host. - Delete Folder: :::warning[Cascading model card deletion] documents "Also delete the associated model folder" option, cascade-warning copy from i18n, and cross-references admin_menu#manage-model-cards. Updated in all 4 languages (en/ko/ja/th). 3 new screenshots flagged with TODO markers.
1 parent 3aeee5f commit 9ff7773

4 files changed

Lines changed: 191 additions & 0 deletions

File tree

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,22 @@ such as the folder name and ID, the NFS host name where the folder is located
1414
There are two types of storage folders: `User` and `Project`. You can
1515
distinguish between them in the 'Type' column.
1616

17+
### Invitation Badge and Entry Point
18+
19+
When another user invites you to share one of their storage folders, a small
20+
invitation badge appears on the Data page entry in the sidebar and next to the
21+
folder status summary. The badge displays the number of pending invitations
22+
that still need a response.
23+
24+
![](../images/vfolder_invitation_badge.png)
25+
<!-- TODO: Capture screenshot of the invitation badge on the Data page -->
26+
27+
Click the badge to open the invitation list, where you can accept or decline
28+
each pending invitation. Accepted folders immediately appear in your folder
29+
list with the `Invited` type. The `/data` page itself is also a valid entry
30+
point for reviewing invitations — open the Data page and the same invitation
31+
list is reachable from the folder status summary.
32+
1733
A User folder is created directly by an individual user for personal use.
1834
A Project folder is created by a domain administrator for each project.
1935
Regular users cannot create project folders themselves; they can only use
@@ -97,6 +113,23 @@ You can create a new directory on the current path with the 'Create' button
97113
of these file operations can also be performed using the above-described method
98114
of mounting folders into a compute session.
99115

116+
:::warning
117+
The 'Upload' button (and drag-and-drop upload) is **disabled** when your account
118+
does not have the `upload-file` permission on the storage host that hosts this
119+
folder. The button itself remains visible but is greyed out, and tooltips
120+
explain that uploads are not permitted.
121+
122+
`upload-file` is a host-level capability granted through your **keypair
123+
resource policy**. If you need to upload files and the button is disabled, ask
124+
your administrator to add `upload-file` to the allowed sFTP / vfolder host
125+
permissions on your resource policy. You can identify which host the folder
126+
lives on from the **Location** column in the folder list or from the folder
127+
detail drawer; the required permission must be enabled for *that* host.
128+
:::
129+
130+
![](../images/vfolder_upload_disabled.png)
131+
<!-- TODO: Capture screenshot of the disabled Upload button with permission tooltip -->
132+
100133
The maximum length of file or directory inside a folder may depends on the host
101134
file system. But, it usually cannot exceed 255 characters.
102135

@@ -153,6 +186,25 @@ into the field, and click the red 'DELETE FOREVER' button to permanently delete
153186

154187
![](../images/vfolder_delete_dialog.png)
155188

189+
:::warning[Cascading model card deletion]
190+
If the folder you are deleting is associated with a **model card**, the
191+
confirmation modal additionally surfaces the option *"Also delete the
192+
associated model folder"* with the warning *"Deleting the associated model
193+
folder will also delete every model card that uses it."* Proceeding with the
194+
deletion permanently removes every model card backed by this storage folder —
195+
not just the folder's files. Review the listed model cards before confirming;
196+
this action cannot be undone.
197+
:::
198+
199+
![](../images/vfolder_cascading_delete_warning.png)
200+
<!-- TODO: Capture screenshot of the cascading delete warning dialog -->
201+
202+
Administrators who delete model cards from the **Admin → Manage Model Cards**
203+
page can trigger the inverse flow — bulk-deleting model cards offers an option
204+
to also move the associated storage folders to the trash. See
205+
[Manage Model Cards](../admin_menu/admin_menu.md#manage-model-cards) for the
206+
admin-side bulk flow.
207+
156208
## Using FileBrowser
157209

158210

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

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専
88

99
ストレージフォルダには、`ユーザー``プロジェクト`の2つのタイプがあります。「種類」列で区別できます。
1010

11+
### 招待バッジとエントリーポイント
12+
13+
他のユーザーが自分のストレージフォルダを共有するために招待を送ると、サイドバーのデータ
14+
ページ項目とフォルダステータスの概要の横に小さな招待バッジが表示されます。バッジには、
15+
まだ応答していない保留中の招待の件数が表示されます。
16+
17+
![](../images/vfolder_invitation_badge.png)
18+
<!-- TODO: データページの招待バッジのスクリーンショットを撮影します -->
19+
20+
バッジをクリックすると招待リストが開き、保留中の各招待を受諾または辞退できます。
21+
受諾したフォルダは即座にフォルダ一覧に `招待` タイプとして表示されます。`/data`
22+
ページ自体も招待を確認するための有効なエントリーポイントです。データページを開けば、
23+
フォルダステータスの概要から同じ招待リストにアクセスできます。
24+
1125
ユーザーフォルダは、個々のユーザーが個人的に使用するために直接作成したフォルダです。
1226
プロジェクトフォルダは、ドメイン管理者が各プロジェクトに対して作成したフォルダです。
1327
一般ユーザーは自分でプロジェクトフォルダを作成できません。管理者が作成したプロジェクトフォルダのみ使用できます。
@@ -76,6 +90,23 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専
7690

7791
現在のパスに新しいディレクトリを作成するには、「作成」ボタン(フォルダーエクスプローラー内)を使用するか、ローカルファイルやフォルダーをアップロードするには「アップロード」ボタンを使用します。これらのファイル操作は、上記のフォルダーをコンピューターセッションにマウントする方法を使用して実行することもできます。
7892

93+
:::warning
94+
お使いのアカウントに、このフォルダがホストされているストレージホストに対する
95+
`upload-file` 権限がない場合、「アップロード」ボタン(およびドラッグアンドドロップでの
96+
アップロード)は **無効化** されます。ボタン自体は表示されますがグレーアウトされ、
97+
ツールチップでアップロードが許可されていないことが案内されます。
98+
99+
`upload-file` は、ユーザーの **キーペアリソースポリシー** を通じて付与されるホストレベルの
100+
権限です。ファイルをアップロードする必要があるのにボタンが無効になっている場合は、
101+
管理者に依頼して、リソースポリシーで許可されている sFTP / vfolder ホスト権限に
102+
`upload-file` を追加してもらってください。フォルダがどのホスト上にあるかは、
103+
フォルダ一覧の **ロケーション** 列、またはフォルダ詳細ドロワーで確認できます。
104+
必要な権限は *該当する* ホストに対して有効になっている必要があります。
105+
:::
106+
107+
![](../images/vfolder_upload_disabled.png)
108+
<!-- TODO: 権限ツールチップが表示された無効状態のアップロードボタンのスクリーンショットを撮影します -->
109+
79110
フォルダ内のファイルまたはディレクトリの最大長は、ホストファイルシステムに依存することがあります。しかし、通常は255文字を超えることはできません。
80111

81112

@@ -122,6 +153,24 @@ Backend.AIは、ユーザーのファイルを安全に保管するための専
122153

123154
![](../images/vfolder_delete_dialog.png)
124155

156+
:::warning[モデルカードの連鎖削除]
157+
削除対象のフォルダが **モデルカード** に関連付けられている場合、確認モーダルには
158+
*「関連するモデルフォルダも削除する」* オプションと *「関連するモデルフォルダを削除すると、
159+
そのフォルダを使用しているすべてのモデルカードも削除されます。」* という警告メッセージが
160+
追加で表示されます。このまま削除を実行すると、このストレージフォルダを基盤とする
161+
すべてのモデルカードが永久に削除されます。フォルダのファイルだけが削除されるわけでは
162+
ありません。削除を確定する前に、一覧に表示されるモデルカードを必ず確認してください。
163+
この操作は元に戻せません。
164+
:::
165+
166+
![](../images/vfolder_cascading_delete_warning.png)
167+
<!-- TODO: 連鎖削除警告ダイアログのスクリーンショットを撮影します -->
168+
169+
**管理 → モデルカード管理** ページでモデルカードを削除する管理者は、逆の流れも利用できます。
170+
モデルカードを一括削除する際に、関連付けられたストレージフォルダもゴミ箱に移動する
171+
オプションを選択できます。管理者側の一括処理フローについては
172+
[モデルカード管理](../admin_menu/admin_menu.md#manage-model-cards) を参照してください。
173+
125174
## ファイルブラウザの使用
126175

127176

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,20 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용
88

99
스토리지 폴더에는 `사용자``프로젝트` 두 가지 유형이 있습니다. '종류' 열에서 구분할 수 있습니다.
1010

11+
### 초대 배지 및 진입점
12+
13+
다른 사용자가 자신의 스토리지 폴더를 공유하기 위해 초대를 보내면, 사이드바의 데이터
14+
페이지 항목과 폴더 상태 요약 옆에 작은 초대 배지가 표시됩니다. 배지에는 아직 응답하지
15+
않은 대기 중인 초대의 개수가 함께 표시됩니다.
16+
17+
![](../images/vfolder_invitation_badge.png)
18+
<!-- TODO: 데이터 페이지의 초대 배지 스크린샷을 캡처합니다 -->
19+
20+
배지를 클릭하면 초대 목록이 열리며, 대기 중인 초대를 각각 수락하거나 거절할 수
21+
있습니다. 수락한 폴더는 즉시 폴더 목록에 `초대받음` 유형으로 표시됩니다. `/data` 페이지
22+
자체도 초대를 검토하는 유효한 진입점입니다. 데이터 페이지를 열면 폴더 상태 요약에서
23+
동일한 초대 목록에 접근할 수 있습니다.
24+
1125
사용자 폴더는 일반 사용자가 직접 생성하여 개인적으로 사용하는 폴더입니다. 프로젝트 폴더는 도메인 관리자가 프로젝트별로 생성하는 폴더입니다. 일반 사용자는 프로젝트 폴더를 직접 생성할 수 없으며, 관리자가 생성한 프로젝트 폴더만 사용할 수 있습니다.
1226

1327
![](../images/vfolder_status.png)
@@ -76,6 +90,21 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용
7690

7791
'만들기' 버튼으로 현재 경로에 새로운 폴더를 생성할 수 있으며, '업로드' 버튼으로 현재 경로에 로컬 파일 혹은 폴더를 업로드할 수도 있습니다. 이러한 파일 작업은 앞서 설명한 연산 세션 마운트 방식으로도 모두 수행 가능합니다.
7892

93+
:::warning
94+
사용자의 계정에 해당 폴더가 위치한 스토리지 호스트에 대한 `upload-file` 권한이 없으면
95+
'업로드' 버튼(및 드래그 앤 드롭 업로드)은 **비활성화**됩니다. 버튼 자체는 표시되지만
96+
회색으로 변하며, 툴팁을 통해 업로드가 허용되지 않는다는 안내가 표시됩니다.
97+
98+
`upload-file`은 사용자의 **키페어 자원 정책**을 통해 부여되는 호스트 수준의 권한입니다.
99+
업로드가 필요한데 버튼이 비활성화되어 있다면, 자원 정책에서 허용된 sFTP / vfolder
100+
호스트 권한에 `upload-file`을 추가해 달라고 관리자에게 요청하세요. 폴더가 어떤
101+
호스트에 위치해 있는지는 폴더 목록의 **위치** 열이나 폴더 상세 드로어에서 확인할 수
102+
있으며, 필요한 권한은 *해당* 호스트에 대해 활성화되어 있어야 합니다.
103+
:::
104+
105+
![](../images/vfolder_upload_disabled.png)
106+
<!-- TODO: 권한 툴팁이 표시된 비활성화 상태의 업로드 버튼 스크린샷을 캡처합니다 -->
107+
79108
폴더 내 파일 또는 디렉토리의 최대 이름 길이는 호스트 파일 시스템에 따라 달라질 수 있습니다. 일반적으로 255자를 초과할 수 없습니다.
80109

81110

@@ -122,6 +151,23 @@ Backend.AI는 사용자의 파일을 안전하게 보관할 수 있도록 전용
122151

123152
![](../images/vfolder_delete_dialog.png)
124153

154+
:::warning[모델 카드 연쇄 삭제]
155+
삭제하려는 폴더가 **모델 카드**와 연결되어 있는 경우, 확인 모달에는 *"연결된 모델
156+
폴더도 함께 삭제"* 옵션과 *"연결된 모델 폴더를 삭제하면 해당 폴더를 사용하는 모든
157+
모델 카드도 함께 삭제됩니다."*라는 경고 메시지가 추가로 표시됩니다. 이 상태에서
158+
삭제를 진행하면 해당 스토리지 폴더를 기반으로 하는 모든 모델 카드가 영구적으로
159+
제거됩니다. 폴더의 파일만 삭제되는 것이 아닙니다. 삭제를 확정하기 전에 함께 삭제되는
160+
모델 카드 목록을 반드시 확인하세요. 이 작업은 되돌릴 수 없습니다.
161+
:::
162+
163+
![](../images/vfolder_cascading_delete_warning.png)
164+
<!-- TODO: 연쇄 삭제 경고 대화 상자의 스크린샷을 캡처합니다 -->
165+
166+
**관리자 → 모델 카드 관리** 페이지에서 모델 카드를 삭제하는 관리자는 반대 흐름도 사용할
167+
수 있습니다. 모델 카드를 일괄 삭제할 때, 연결된 스토리지 폴더도 함께 휴지통으로 보내는
168+
옵션을 선택할 수 있습니다. 관리자 측의 일괄 처리 흐름에 대해서는
169+
[모델 카드 관리](../admin_menu/admin_menu.md#manage-model-cards)를 참고하세요.
170+
125171
## 파일 브라우저 사용하기
126172

127173

0 commit comments

Comments
 (0)