Skip to content

Commit

Permalink
fix: warning: title underline too short
Browse files Browse the repository at this point in the history
  • Loading branch information
adrysn committed Jan 6, 2021
1 parent fe3dfbe commit c7ddf1d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
20 changes: 10 additions & 10 deletions docs/sessions_all/sessions_all.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ the Sessions page.
Start a new session
-------------------

After logging in with a user account, click Sessions on the left sidebar to visit the Sessions page.
Sessions page lets you start new sessions or use and manage existing running sessions.
After logging in with a user account, click Sessions on the left sidebar to visit the Sessions page.
Sessions page lets you start new sessions or use and manage existing running sessions.

.. image:: sessions_page.png

Expand Down Expand Up @@ -63,14 +63,14 @@ If you need more detailed settings, refer to the meaning of each items.
sessions at once.

If no folder is specified in "Folders to mount", a warning dialog may
appear indicating that no storage folder is mounted.
appear indicating that no storage folder is mounted.

.. image:: no_vfolder_notification_dialog.png
:width: 350
:align: center
:alt: Notification dialog when no storage folder is mounted to the session

You may ignore the warning, but it is recommended to mount
You may ignore the warning, but it is recommended to mount
at least one storage folder because terminating a compute session by
default deletes all the data inside the session. If you specify a folder to mount
and save your data in that folder, you can keep the data even if the compute
Expand All @@ -79,12 +79,12 @@ by re-mounting it when creating another compute session. For the information on
to mount a folder and run a compute session, see
:ref:`Mounting Folders to a Compute Session <session-with-mounts>`.

Now a new compute session is created in the RUNNING tab.
Now a new compute session is created in the RUNNING tab.

.. image:: session_created.png

In the RUNNING tab, you can check the information on the currently running
sessions. FINISHED tab shows the list of terminated sessions and OTHERS tab shows the compute sessions with errors.
sessions. FINISHED tab shows the list of terminated sessions and OTHERS tab shows the compute sessions with errors.
For each session, you can check the information such as session environments, the amount of allocated
and used resources, session starting time, etc.

Expand Down Expand Up @@ -127,7 +127,7 @@ accessible resources.
configuration, if you create a compute session by allocating 1 FGPU, you can
utilize SM (streaming multiprocessor) and GPU memory corresponding to 0.2
physical GPU for the session.


Use Jupyter Notebook
----------------------
Expand All @@ -151,7 +151,7 @@ When you click the first icon, the app launcher pops up and shows the available
for anyone who knows the service URL (and port number) to access and use it. Of
course, the user must have a network path to access the service.
* Try preferred port: Without this option checked, a port number for the web service is randomly
assigned from the port pool prepared in advance by Backend.AI.
assigned from the port pool prepared in advance by Backend.AI.
If you check this item and enter a specific port number, the entered
port number will be tried first. However, there is no guarantee that the desired
port will always be assigned because the port may not exist at all in the port
Expand Down Expand Up @@ -199,7 +199,7 @@ after the session is terminated is described in the Data & Storage Folders secti


Use web terminal
------------
----------------

Return to the Session list page. This time, let's launch the terminal. Click the
terminal icon (the second button in the Control panel) to use the container's ttyd daemon. A terminal
Expand Down Expand Up @@ -239,7 +239,7 @@ Delete a compute session

To terminate a specific session, simply click on the red power icon and click
OKAY button in the dialog. Since the data in the folder inside the compute
session is deleted as soon as the compute session ends, it is recommended to move the data
session is deleted as soon as the compute session ends, it is recommended to move the data
to the mounted folder or upload it to the mounted folder from the beginning if you want to keep it.

.. image:: session_destroy_dialog.png
Expand Down
18 changes: 9 additions & 9 deletions docs/vfolder/vfolder.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================
===============================
Handling Data & Storage Folders
================
===============================

Backend.AI supports dedicated storage to preserve user's files. Since the files
and directories of a compute session are deleted upon session termination, it is
Expand All @@ -20,17 +20,17 @@ users in the panel. Group folders are created by domain admins, and normal
users can only see group folders created for the group in which the users
belong.

Storage Status on top of the folder list shows the following information:
Storage Status on top of the folder list shows the following information:

* Created: The number of folders that the user created.
* Invited: The number of folers that the user was invited to share.
* Capacity: The maximum number of folders that the user can create afterwards.
This value depends on the resource policy applied to the user and cannot be changed
without changing the resource policy. Folders that were not created by the user (eg. folders invited to share, or group folders) are not counted.
* Capacity: The maximum number of folders that the user can create afterwards.
This value depends on the resource policy applied to the user and cannot be changed
without changing the resource policy. Folders that were not created by the user (eg. folders invited to share, or group folders) are not counted.

Check marks on the Owner panel in the folder list indicate the user created folders.
Check marks on the Owner panel in the folder list indicate the user created folders.

.. image:: vfolder_status.png
.. image:: vfolder_status.png
:alt: Storage status in Storage page

Create storage folder
Expand Down Expand Up @@ -63,7 +63,7 @@ follows.
General, Data, and Model. It is classified for the development of exclusive functions
for Data & Model Stores in the future and currently there is no
difference in UI depending on the purpose.
* Group: Designates the group to which the folder belongs when creating a new group folder.
* Group: Designates the group to which the folder belongs when creating a new group folder.
Group folders must belong to a group. However, it does not play any
role when creating a user folder.

Expand Down

0 comments on commit c7ddf1d

Please sign in to comment.