docs: Update documentation with new UI (#13)

* docs: update session launcher image files and related ones to reflect the latest UI of session launcher dialog * docs: add environment configuration dialog documentation * docs: fix omitted word in filebrowser documentation translated in Korean * Move environment variables section after destroy session section Co-authored-by: Jonghyun Park <adrysn@gmail.com>
lablup · Mar 25, 2021 · d3eb02a · d3eb02a
1 parent 2507719
commit d3eb02a
Show file tree

Hide file tree

Showing 20 changed files with 1,167 additions and 923 deletions.
diff --git a/docs/appendix/appendix.rst b/docs/appendix/appendix.rst
@@ -131,30 +131,29 @@ kernel images depending on the installation settings.
    :width: 350
    :align: center
 
-Here, let's select the TensorFlow 2.2 environment and created a session.
+Here, let's select the TensorFlow 2.3 environment and created a session.
 
-.. image:: session_launch_dialog_tf22.png
+.. image:: session_launch_dialog_tf23.png
    :width: 350
    :align: center
 
 Open the web terminal of the created session and run the following Python
-command. You can see that TensorFlow 2.2 version is installed.
+command. You can see that TensorFlow 2.3 version is installed.
 
-.. image:: tf22_version_print.png
-   :width: 450
+.. image:: tf23_version_print.png
    :align: center
 
-This time, let's select the TensorFlow 1.13 environment to create a compute
+This time, let's select the TensorFlow 1.15 environment to create a compute
 session. If resources are insufficient, delete the previous session.
 
-.. image:: session_launch_dialog_tf113.png
+.. image:: session_launch_dialog_tf115.png
    :width: 350
    :align: center
 
 Open the web terminal of the created session and run the same Python command as
-before. You can see that TensorFlow 1.13(.1) version is installed.
+before. You can see that TensorFlow 1.15(.4) version is installed.
 
-.. image:: tf113_version_print.png
+.. image:: tf115_version_print.png
    :width: 450
    :align: center
 

diff --git a/docs/appendix/session_launch_dialog_3_sessions.png b/docs/appendix/session_launch_dialog_3_sessions.png
diff --git a/docs/appendix/session_launch_dialog_pytorch15.png b/docs/appendix/session_launch_dialog_pytorch15.png
diff --git a/docs/appendix/session_launch_dialog_tf115.png b/docs/appendix/session_launch_dialog_tf115.png
diff --git a/docs/appendix/session_launch_dialog_tf23.png b/docs/appendix/session_launch_dialog_tf23.png
diff --git a/docs/appendix/session_launch_dialog_with_gpu.png b/docs/appendix/session_launch_dialog_with_gpu.png
diff --git a/docs/appendix/tf115_version_print.png b/docs/appendix/tf115_version_print.png
diff --git a/docs/appendix/tf23_version_print.png b/docs/appendix/tf23_version_print.png
diff --git a/docs/cluster_session/session_launch_dialog.png b/docs/cluster_session/session_launch_dialog.png
diff --git a/docs/import_run/session_launcher_in_importing_notebook.png b/docs/import_run/session_launcher_in_importing_notebook.png
diff --git a/docs/locale/ko/LC_MESSAGES/appendix/appendix.po b/docs/locale/ko/LC_MESSAGES/appendix/appendix.po
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/vfolder/vfolder.po b/docs/locale/ko/LC_MESSAGES/vfolder/vfolder.po
@@ -487,15 +487,15 @@ msgstr "파일 브라우저에서 원하는 디렉토리나 파일을 선택하
 
 #: ../../vfolder/vfolder.rst:276
 msgid "Click the arrow icon in the upper right corner of FileBrowser"
-msgstr "파일 브라우저 창 우측 상단의 화살표 아이콘을 클릭합니"
+msgstr "파일 브라우저 창 우측 상단의 화살표 아이콘을 클릭합니다."
 
 #: ../../vfolder/vfolder.rst:282
 msgid "Select the destination"
-msgstr "이동할 경로를 선택합니다"
+msgstr "이동할 경로를 선택합니다."
 
 #: ../../vfolder/vfolder.rst:288
 msgid "Click MOVE button"
-msgstr "MOVE 버튼을 클릭합니다"
+msgstr "MOVE 버튼을 클릭합니다."
 
 #: ../../vfolder/vfolder.rst:290
 msgid "You will see that moving operation is successfully finished."

diff --git a/docs/mount_vfolder/create_session_with_folders.png b/docs/mount_vfolder/create_session_with_folders.png
diff --git a/docs/sessions_all/env-config-dialog-closing-confirmation.png b/docs/sessions_all/env-config-dialog-closing-confirmation.png
diff --git a/docs/sessions_all/env-config-dialog-info.png b/docs/sessions_all/env-config-dialog-info.png
diff --git a/docs/sessions_all/env-config-dialog.png b/docs/sessions_all/env-config-dialog.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/session_launch_dialog.png b/docs/sessions_all/session_launch_dialog.png
diff --git a/docs/sessions_all/sessions_all.rst b/docs/sessions_all/sessions_all.rst
@@ -45,6 +45,7 @@ If you need more detailed settings, refer to the meaning of each items.
 * Folder to mount: Specifies the data folders to be mounted in the compute
   session. When a compute session is deleted, all data is deleted
   altogether by default, but the data stored in the folder mounted here is not deleted.
+* Set Environment Variable: Provides customized environment variable before creating a session.
 * Resource allocation: This is a template that has predefined resources to be
   allocated to the compute session. You can save and use frequently used
   resource settings in advance. Resource templates can be managed in a dedicated
@@ -246,6 +247,49 @@ to the mounted folder or upload it to the mounted folder from the beginning if y
    :align: center
 
 
+How to add environment variable before creating a session
+---------------------------------------------------------
+
+To give more convenient workspace for users, Backend.AI supports environment variable setting
+in session launching. In this feature, you can add any envs such as ``PATH`` by filling out
+variable name and value in environment configuration dialog.
+
+To add environment variable, simply click CONFIG button.
+
+.. image:: env-config-start.png
+   :width: 350
+   :align: center
+   :alt: Env Configuration Button
+
+and then, environment configuration dialog appears.
+
+In this dialog, you can add,update and delete written env variables.
+To see more information about how it works, please click 'i' button at the header of the dialog.
+
+.. image:: env-config-dialog-info.png
+   :align: center
+   :alt: Env Configuration info
+
+You can input variable name and value in the same line of the input fields.
+Then, click save button. It will be applied in the session.
+
+.. warning::
+   If you close the dialog without click saving variables or If you didn't fill out
+   the variable and value, then those input values will not be applied into the session as env.
+   Please remind that every variable and value that is not empty will be applied to session by
+   clicking SAVE button.
+
+   .. image:: env-config-dialog-closing-confirmation.png
+      :width: 350
+      :align: center
+      :alt: Env config dialog closing confirmation
+
+To Add more environment variables, yon can click ``+`` button in the right side of the first row of input field.
+Also, you can remove the variable by clicking ``-`` button of the row that you want to get rid of.
+
+If you want to delete the whole variables and value, please click DELETE ALL button at the bottom of the dialog.
+
+
 Advanced web terminal usage
 ---------------------------