docs: update for 24.03.0 (#54)

* docs: update user image push of session page * docs: translate fuzzy strings * docs: update session related page for neo session launcher * docs: add ssh/sftp connection feature support from 24.03 with korean translation * docs: change session launcher dialog in cluster_session to proper image * docs: add extra informations about container commit and converting to image with figure * docs: fix typo in appendix --------- Co-authored-by: Jihyun Kang <jihyunkang@lablup.com>
lablup · Apr 6, 2024 · 0cefc5f · 0cefc5f
1 parent 4a2bfdb
commit 0cefc5f
Show file tree

Hide file tree

Showing 29 changed files with 628 additions and 579 deletions.
diff --git a/docs/cluster_session/cluster_session.rst b/docs/cluster_session/cluster_session.rst
@@ -101,7 +101,7 @@ size). Also, don't forget to mount the data folder for data safekeeping.
 
 .. image::
    session_launch_dialog.png
-   :width: 400
+   :width: 800
    :align: center
 
 In the "Cluster mode" field at the bottom, you can choose what type of cluster

diff --git a/docs/cluster_session/session_launch_dialog.png b/docs/cluster_session/session_launch_dialog.png
diff --git a/docs/locale/ko/LC_MESSAGES/appendix/appendix.po b/docs/locale/ko/LC_MESSAGES/appendix/appendix.po
@@ -516,7 +516,7 @@ msgid ""
 ":ref:`How to create a session<create_session>` section."
 msgstr ""
 "이 섹션에서는, 세션을 이미 성공적으로 생성하고, 세션 내 앱을 실행할 수 있는 상태라고 가정합니다. 만약 세션을 생성하고 세션 "
-"내에서 앱을 실행하는 방법을 모르신다면, :ref`세션 생성하기 세션<create_session>` 을 반드시 먼저 보고 오시기 "
+"내에서 앱을 실행하는 방법을 모르신다면, :ref:`세션 생성하기<create_session>` 를 반드시 먼저 보고 오시기 "
 "바랍니다."
 
 #: ../../appendix/appendix.rst:291
@@ -543,7 +543,6 @@ msgstr ""
 "예제로 실험 결과를 확인해봅시다."
 
 #: ../../appendix/appendix.rst:315
-#, fuzzy
 msgid "After executing python code, you may see the experiments result in MLFlow."
 msgstr "Python 코드를 실행하면, MLFlow 에서 결과값을 확인할 수 있습니다."
 

diff --git a/docs/locale/ko/LC_MESSAGES/overview/overview.po b/docs/locale/ko/LC_MESSAGES/overview/overview.po
@@ -328,9 +328,8 @@ msgid "(Enterprise) Access control of users to"
 msgstr ""
 
 #: ../../overview/overview.rst
-#, fuzzy
 msgid "resource group"
-msgstr "자원 (Resources)*"
+msgstr "자원 그룹 (Resource group)*"
 
 #: ../../overview/overview.rst
 msgid "(Enterprise) Access control of project to"

diff --git a/docs/locale/ko/LC_MESSAGES/quickstart.po b/docs/locale/ko/LC_MESSAGES/quickstart.po
@@ -8,14 +8,14 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Backend.AI Web-UI User Guide 23.03\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-03-09 14:40+0900\n"
+"POT-Creation-Date: 2024-04-06 14:21+0900\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\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.12.1\n"
 
 #: ../../quickstart.rst:2
 msgid "Quickstart"
@@ -68,8 +68,8 @@ msgid ""
 msgstr ":ref:`자동마운트되는 가상폴더를 사용해서 pip 패키지를 설치하는 방법<install_pip_pkg>` "
 
 #: ../../quickstart.rst:23
-msgid ":ref:`How to use SSH/sFTP using desktop application<ssh-sftp-container>`"
-msgstr ":ref:`데스크톱 애플리케이션으로 SSH/sFTP 을 사용하는 방법<ssh-sftp-container>` "
+msgid ":ref:`How to use SSH/sFTP <ssh-sftp-container>`"
+msgstr ":ref:`Backend.AI에서 SSH/sFTP 을 사용하는 방법<ssh-sftp-container>` "
 
 #: ../../quickstart.rst:24
 msgid ":ref:`How to install apt packages<installing_apt_pkg>`"

diff --git a/docs/locale/ko/LC_MESSAGES/sessions_all/sessions_all.po b/docs/locale/ko/LC_MESSAGES/sessions_all/sessions_all.po
diff --git a/docs/locale/ko/LC_MESSAGES/sftp_to_container/sftp_to_container.po b/docs/locale/ko/LC_MESSAGES/sftp_to_container/sftp_to_container.po
diff --git a/docs/mount_vfolder/create_session_with_folders.png b/docs/mount_vfolder/create_session_with_folders.png
diff --git a/docs/mount_vfolder/mount_vfolder.rst b/docs/mount_vfolder/mount_vfolder.rst
@@ -22,7 +22,6 @@ folders, ``user1-ml-test`` and ``user2-vfolder``, and then create a compute
 session.
 
 .. image:: create_session_with_folders.png
-   :width: 350
    :align: center
    :alt: Launch a compute session with storage folders
 

diff --git a/docs/quickstart.rst b/docs/quickstart.rst
@@ -20,5 +20,5 @@ Part 2. Advanced guide to using Backend.AI
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - :ref:`How to use terminal application with tmux<tmux_guide>`
 - :ref:`How to install extra pip package using automount virtual folder<install_pip_pkg>`
-- :ref:`How to use SSH/sFTP using desktop application<ssh-sftp-container>`
+- :ref:`How to use SSH/sFTP <ssh-sftp-container>`
 - :ref:`How to install apt packages<installing_apt_pkg>`
diff --git a/docs/sessions_all/container_commit.png b/docs/sessions_all/container_commit.png
diff --git a/docs/sessions_all/copy_customized_image.png b/docs/sessions_all/copy_customized_image.png
diff --git a/docs/sessions_all/env-config-start.png b/docs/sessions_all/env-config-start.png
diff --git a/docs/sessions_all/launch_session_1.png b/docs/sessions_all/launch_session_1.png
diff --git a/docs/sessions_all/launch_session_2.png b/docs/sessions_all/launch_session_2.png
diff --git a/docs/sessions_all/launch_session_3.png b/docs/sessions_all/launch_session_3.png
diff --git a/docs/sessions_all/launch_session_4.png b/docs/sessions_all/launch_session_4.png
diff --git a/docs/sessions_all/launch_session_5.png b/docs/sessions_all/launch_session_5.png
diff --git a/docs/sessions_all/launch_session_error_card.png b/docs/sessions_all/launch_session_error_card.png
diff --git a/docs/sessions_all/no_vfolder_notification_dialog.png b/docs/sessions_all/no_vfolder_notification_dialog.png
diff --git a/docs/sessions_all/preopen-ports-config.png b/docs/sessions_all/preopen-ports-config.png
diff --git a/docs/sessions_all/push_session_to_customized_image.png b/docs/sessions_all/push_session_to_customized_image.png
diff --git a/docs/sessions_all/resource_presets.png b/docs/sessions_all/resource_presets.png
diff --git a/docs/sessions_all/select_customized_image.png b/docs/sessions_all/select_customized_image.png
diff --git a/docs/sessions_all/session_hpc_optimization.png b/docs/sessions_all/session_hpc_optimization.png
diff --git a/docs/sessions_all/session_type_batch.png b/docs/sessions_all/session_type_batch.png
diff --git a/docs/sessions_all/sessions_all.rst b/docs/sessions_all/sessions_all.rst
diff --git a/docs/sessions_all/sessions_page.png b/docs/sessions_all/sessions_page.png
diff --git a/docs/sftp_to_container/sftp_to_container.rst b/docs/sftp_to_container/sftp_to_container.rst
@@ -7,21 +7,36 @@ SSH/SFTP Connection to a Compute Session
 Backend.AI supports SSH/SFTP connection to the created compute sessions
 (containers). In this section, we will learn how to do it.
 
-.. note::
-   SSH/SFTP connection feature is supported through a WebUI Desktop application. 
-   Currently web-based WebUI does not support this feature due to limitations of file system
-   access on browser-level. Desktop app can be downloaded a panel from the Summary page. Using
-   this panel, the compatible version will be downloaded automatically.
-
-   .. image:: app_download_panel.png
-      :width: 350
-      :align: center
-
-   You can also download the app from
-   https://github.com/lablup/backend.ai-webui/releases. Make sure to download
-   the compatible version of the Web-UI in this case. You can check the Web-UI
-   version by clicking on the "About Backend.AI" sub-menu located in the
-   preference menu on the upper-right side of the GUI.
+   .. note::
+      From 24.03 SSH/SFTP connection feature is available in both Web browser and WebUI Desktop application.
+      When the version is 23.09 or lower version, you need to use WebUI Desktop app. Desktop app can be downloaded 
+      a panel from the Summary page. Using this panel, the compatible version will be downloaded automatically.
+
+      .. image:: app_download_panel.png
+         :width: 350
+         :align: center
+
+      You can also download the app from
+      https://github.com/lablup/backend.ai-webui/releases. Make sure to download
+      the compatible version of the Web-UI in this case. You can check the Web-UI
+      version by clicking on the "About Backend.AI" sub-menu located in the
+      preference menu on the upper-right side of the GUI.
+
+.. .. note::
+..    SSH/SFTP connection feature is supported through a WebUI Desktop application. 
+..    Currently web-based WebUI does not support this feature due to limitations of file system
+..    access on browser-level. Desktop app can be downloaded a panel from the Summary page. Using
+..    this panel, the compatible version will be downloaded automatically.
+
+..    .. image:: app_download_panel.png
+..       :width: 350
+..       :align: center
+
+..    You can also download the app from
+..    https://github.com/lablup/backend.ai-webui/releases. Make sure to download
+..    the compatible version of the Web-UI in this case. You can check the Web-UI
+..    version by clicking on the "About Backend.AI" sub-menu located in the
+..    preference menu on the upper-right side of the GUI.
 
 .. _sftp_connection_for_linux_and_mac: