Skip to content

Commit

Permalink
docs: update images and add description of default session launcher
Browse files Browse the repository at this point in the history
  • Loading branch information
ironAiken2 committed Nov 25, 2024
1 parent 5aa99ae commit 6d7edcd
Show file tree
Hide file tree
Showing 8 changed files with 75 additions and 50 deletions.
103 changes: 64 additions & 39 deletions docs/locale/ko/LC_MESSAGES/share_vfolder/share_vfolder.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ msgid ""
msgstr ""
"Project-Id-Version: Backend.AI Console Essential Guide Enterprise R2\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-03-08 18:54+0900\n"
"POT-Creation-Date: 2024-10-24 14:04+0900\n"
"PO-Revision-Date: 2021-01-21 11:13+0900\n"
"Last-Translator: \n"
"Language: ko_KR\n"
"Language-Team: \n"
"Plural-Forms: nplurals=1; plural=0\n"
"Plural-Forms: nplurals=1; plural=0;\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.8.0\n"
"Generated-By: Babel 2.14.0\n"

#: ../../share_vfolder/share_vfolder.rst:3
msgid "Sharing Storage Folders and Access Control"
Expand Down Expand Up @@ -60,13 +60,13 @@ msgid ""
" B's account."
msgstr "사용자B의 계정으로 로그인 했을 때 ``tests`` 폴더가 조회되지 않는 것을 확인합니다."

#: ../../share_vfolder/share_vfolder.rst:28
#: ../../share_vfolder/share_vfolder.rst:30
msgid ""
"If a folder named ``tests`` already exists in User B's account, User A's "
"``tests`` folder cannot be shared with User B."
msgstr ""
"만약 사용자B 계정에 ``tests`` 라는 이름의 폴더가 이미 존재한다면 사용자A의 ``tests`` 폴더는 사용자B에게 공유할 "
"없습니다."
"만약 사용자B 계정에 ``tests`` 라는 이름의 폴더가 이미 존재한다면 사용자A의 ``tests`` 폴더는 사용자B에게 공유할 "
"없습니다."

#: ../../share_vfolder/share_vfolder.rst:33
msgid ""
Expand All @@ -79,8 +79,8 @@ msgid ""
"writing is allowed to User B. If you want to share with multiple users, "
"you can also click the + button to enter additional emails."
msgstr ""
"사용자A 계정으로 이동한 뒤 ``tests`` 폴더의 우측 Control 열에 있는 세 번째 공유 아이콘을 클릭합니다. 이메일 입력 "
"필드에 사용자B의 이메일을 입력하고 SHARE 버튼을 클릭해서 공유 초대장을 발송합니다. 실제 이메일이 발송되는 것은 아니며, "
"사용자A 계정으로 이동한 뒤 ``tests`` 폴더의 우측 Control 열에 있는 세 번째 공유 아이콘을 클릭합니다. 이메일 입력"
" 필드에 사용자B의 이메일을 입력하고 SHARE 버튼을 클릭해서 공유 초대장을 발송합니다. 실제 이메일이 발송되는 것은 아니며, "
"Backend.AI 데이터베이스를 통해 초대장이 생성됩니다. Permissions의 경우, View를 체크하면 읽기 전용으로 "
"공유하게 되고, Edit까지 같이 체크하면 쓰기 작업까지도 사용자B에게 허용합니다. 만약 여러 사용자에게 공유하고 싶다면 + 버튼을"
" 클릭하여 이메일을 추가로 입력할 수도 있습니다."
Expand All @@ -95,7 +95,7 @@ msgstr ""
"사용자 B 계정으로 접속해서 Summary 페이지로 이동합니다. 페이지 하단에 Invitation 이라는 제목의 초대장이 도착한 "
"것을 확인할 수 있습니다. ACCEPT 버튼을 클릭하여 초대를 수락합니다."

#: ../../share_vfolder/share_vfolder.rst:52
#: ../../share_vfolder/share_vfolder.rst:54
msgid ""
"Go to the Data & Storage page and check that the ``tests`` folder is "
"displayed in the list. If you don't see it on the list, try refreshing "
Expand All @@ -110,19 +110,35 @@ msgstr ""
"조회할 수 있습니다. 사용자B가 생성한 다른 폴더와 비교해 ``tests`` 폴더는 Control 열에 관리 아이콘이 빠진 것을 "
"확인할 수 있습니다. Permission 열에는 R(읽기전용) 표시만 떠 있는 것도 볼 수 있습니다."

#: ../../share_vfolder/share_vfolder.rst:61
#: ../../share_vfolder/share_vfolder.rst:63
msgid ""
"Let's navigate inside the ``tests`` folder by clicking the folder icon in"
" the Control panel of ``tests``. You can check the ``hello.txt`` and "
"``myfolder`` that you checked in the User A's account again. Let's create"
" a compute session by mounting this storge folder with the User B's "
"account."
msgstr ""
"``tests`` 의 Control 패널에서 폴더 아이콘을 클릭하여 ``tests`` 폴더 내부를 탐색 해 보겠습니다. 사용자 A의 "
"계정에서 확인한 ``hello.txt`` 와 ``myfolder`` 를 다시 확인할 수 있습니다. 이 저장소 폴더를 사용자 B의 "
"``tests`` 의 Control 패널에서 폴더 아이콘을 클릭하여 ``tests`` 폴더 내부를 탐색 해 보겠습니다. 사용자 A의"
" 계정에서 확인한 ``hello.txt`` 와 ``myfolder`` 를 다시 확인할 수 있습니다. 이 저장소 폴더를 사용자 B의 "
"계정으로 마운트하여 컴퓨팅 세션을 생성 해 보겠습니다."

#: ../../share_vfolder/share_vfolder.rst:70
#: ../../share_vfolder/share_vfolder.rst:73
msgid ""
"From version 24.09, Backend.AI offers an improved version of the session "
"launcher (NEO) as default. If you want to use the previous session "
"launcher, please refer :ref:`User Settings<general-settings>` section. "
"For instructions on how to use it, please refer to the following `link "
"<https://webui.docs.backend.ai/en/23.09_a/sessions_all/sessions_all.html>`_."
" If you want to know more about the NEO session launcher, please refer "
":ref:`Create Session<create_session>`"
msgstr ""
"Backend.AI 24.09 버전 부터 세션 런처(NEO)의 개선된 버전을 기본 세션 런처로 제공합니다. 이전의 대화식 세션 "
"런처를 사용하고 싶다면, :ref:`사용자 설정<general-settings>` 를 참고하세요. Classic 세션 런처의 사용 "
"방법에 대한 자세한 내용은 다음 `링크 "
"<https://webui.docs.backend.ai/en/23.09_a/sessions_all/sessions_all.html>`_ 를"
" 참고하세요. "

#: ../../share_vfolder/share_vfolder.rst:78
msgid ""
"After creating a session, open the web terminal and check that the "
"``tests`` folder is mounted in the home folder. The contents of the "
Expand All @@ -131,22 +147,9 @@ msgid ""
"can create a file in the ``tests`` folder if it has been shared including"
" write access."
msgstr ""
"세션 생성 후 웹 터미널을 띄워 ``tests`` 폴더가 홈폴더에 마운트 된 것을 확인합니다. ``tests`` 폴더 내용은 조회가 "
"되지만, 파일을 생성하거나 삭제하려는 시도는 허용되지 않습니다. 사용자A가 읽기 전용으로 공유했기 때문입니다. 만약 쓰기 권한까지 "
"포함하여 공유했다면 사용자B도 ``tests`` 폴더에 파일을 생성할 수 있습니다."

#: ../../share_vfolder/share_vfolder.rst:80
msgid ""
"If you click the folder icon in the Control panel, you may notice that "
"UPLOAD FILES button and NEW FOLDER button disappears and READ-ONLY FOLDER"
" message is shown on that spot. Also modify icon and delete icon in the "
"Action panel are also disabled since the folder is read-only. User B can "
"create a file in the ``tests`` folder if it has been shared including "
"write access."
msgstr ""
"제어판에서 폴더 아이콘을 클릭하면 파일 업로드 버튼과 새 폴더 버튼이 사라지고 그 자리에 READ-ONLY FOLDER 메시지가 "
"표시되는 것을 볼 수 있습니다. 또한 폴더가 읽기 전용이므로 액션 패널의 아이콘 수정 및 삭제 아이콘도 비활성화됩니다. 사용자 "
"B는 쓰기 권한을 포함하여 공유된 경우 ``tests`` 폴더에 파일을 만들 수 있습니다."
"세션 생성 후 웹 터미널을 띄워 ``tests`` 폴더가 홈폴더에 마운트 된 것을 확인합니다. ``tests`` 폴더 내용은 조회가"
" 되지만, 파일을 생성하거나 삭제하려는 시도는 허용되지 않습니다. 사용자A가 읽기 전용으로 공유했기 때문입니다. 만약 쓰기 권한까지"
" 포함하여 공유했다면 사용자B도 ``tests`` 폴더에 파일을 생성할 수 있습니다."

#: ../../share_vfolder/share_vfolder.rst:88
msgid ""
Expand All @@ -169,12 +172,12 @@ msgstr "공유 폴더 권한 조정"

#: ../../share_vfolder/share_vfolder.rst:99
msgid ""
"If you click the fourth person icon in the Control panel, you can see a "
"list of users who have shared the folder. Click Select permission to set "
"the sharing permission."
"If you click the ''person icon'' in the Control panel, you can see a list"
" of users who have shared the folder. Click Select permission to set the "
"sharing permission."
msgstr ""
"Control 패널에서 4번째 아이콘을 클릭하면 폴더를 공유한 사용자 목록을 볼 수 있습니다. 공유 권한을 설정하려면 권한 선택을"
" 클릭합니다."
"Control 패널에서 ''사람 아이콘''을 클릭하면 폴더를 공유한 사용자 목록을 볼 수 있습니다. 공유 권한을 설정하려면 권한 선택을 "
"클릭합니다."

#: ../../share_vfolder/share_vfolder.rst:103
msgid "View: The invited user has read-only access to the folder."
Expand Down Expand Up @@ -248,11 +251,11 @@ msgstr ""
#~ "storge folder with the User B's "
#~ "account."
#~ msgstr ""
#~ "``tests`` 의 Control 열에 폴더 아이콘을 클릭하여"
#~ " ``tests`` 폴더 내부를 탐색해 봅시다. 사용자A "
#~ "계정에서 확인했던 ``hello.txt``, ``myfolder`` "
#~ "다시 확인할 수 있습니다. 사용자B 계정으로 이 "
#~ "폴더를 마운트 하여 연산 세션을 생성해보겠습니다."
#~ "``tests`` 의 Control 열에 폴더 아이콘을 "
#~ "클릭하여 ``tests`` 폴더 내부를 탐색해 봅시다. "
#~ "사용자A 계정에서 확인했던 ``hello.txt``, ``myfolder`` "
#~ "다시 확인할 수 있습니다. 사용자B 계정으로 이"
#~ " 폴더를 마운트 하여 연산 세션을 생성해보겠습니다."

#~ msgid "Sharing a group storage folder with group members"
#~ msgstr "그룹 Storage 폴더를 다른 사용자와 공유하기"
Expand Down Expand Up @@ -335,3 +338,25 @@ msgstr ""
#~ "폴더를 제공하여 유연한 방식으로 데이터 및 모델을 "
#~ "공유할 수 있도록 돕고 있습니다."

#~ msgid ""
#~ "If you click the folder icon in"
#~ " the Control panel, you may notice"
#~ " that UPLOAD FILES button and NEW "
#~ "FOLDER button disappears and READ-ONLY"
#~ " FOLDER message is shown on that "
#~ "spot. Also modify icon and delete "
#~ "icon in the Action panel are also"
#~ " disabled since the folder is "
#~ "read-only. User B can create a "
#~ "file in the ``tests`` folder if it"
#~ " has been shared including write "
#~ "access."
#~ msgstr ""
#~ "제어판에서 폴더 아이콘을 클릭하면 파일 업로드 버튼과 "
#~ "새 폴더 버튼이 사라지고 그 자리에 READ-"
#~ "ONLY FOLDER 메시지가 표시되는 것을 볼 수 "
#~ "있습니다. 또한 폴더가 읽기 전용이므로 액션 패널의 "
#~ "아이콘 수정 및 삭제 아이콘도 비활성화됩니다. 사용자 "
#~ "B는 쓰기 권한을 포함하여 공유된 경우 ``tests``"
#~ " 폴더에 파일을 만들 수 있습니다."

Binary file modified docs/share_vfolder/file_operations_on_shared_test_folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/share_vfolder/launch_session_with_test_mounted_B.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/share_vfolder/modify_perm.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 9 additions & 11 deletions docs/share_vfolder/share_vfolder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,27 +66,25 @@ that you checked in the User A's account again. Let's create a compute session
by mounting this storge folder with the User B's account.

.. image:: launch_session_with_test_mounted_B.png
:width: 350
:width: 100%
:align: center

.. note::
From version 24.09, Backend.AI offers an improved version of the session launcher (NEO)
as default. If you want to use the previous session launcher, please refer :ref:`User Settings<general-settings>`
section. For instructions on how to use it, please refer to the following `link <https://webui.docs.backend.ai/en/23.09_a/sessions_all/sessions_all.html>`_.
If you want to know more about the NEO session launcher, please refer :ref:`Create Session<create_session>`

After creating a session, open the web terminal and check that the ``tests``
folder is mounted in the home folder. The contents of the ``tests`` folder are
displayed, but attempts to create or delete files are not allowed. This is
because User A shared it as read-only. User B can create a file in the ``tests``
folder if it has been shared including write access.

.. image:: file_operations_on_shared_test_folder.png
:width: 450
:width: 100%
:align: center

If you click the folder icon in the Control panel, you may notice that UPLOAD FILES button and
NEW FOLDER button disappears and READ-ONLY FOLDER message is shown on that
spot. Also modify icon and delete icon in the Action panel are also disabled since the
folder is read-only. User B can create a file in the ``tests`` folder if it has
been shared including write access.

.. image:: test_vfolder_explorer_B.png

This way, you can share your personal storage folders with other users based on
your Backend.AI email account.

Expand All @@ -98,7 +96,7 @@ your Backend.AI email account.
Adjust permission for shared folders
------------------------------------

If you click the fourth person icon in the Control panel, you can see a list of
If you click the ''person icon'' in the Control panel, you can see a list of
users who have shared the folder. Click Select permission to set the sharing
permission.

Expand Down
Binary file modified docs/share_vfolder/test_vfolder_explorer_A.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/share_vfolder/test_vfolder_explorer_B.png
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/user_settings/user_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ GENERAL tab
-----------
.. _general-settings:

.. _general-settings:

.. image:: user_settings_page.png

There are lots of preference menu in GENERAL tab. you can search it by search field on top of the section,
Expand Down

0 comments on commit 6d7edcd

Please sign in to comment.