Skip to content

Commit

Permalink
docs: Add documentation for file download from workspaces
Browse files Browse the repository at this point in the history
  • Loading branch information
Paula-Kli committed Oct 10, 2023
1 parent 03017cd commit 88fe091
Show file tree
Hide file tree
Showing 10 changed files with 34 additions and 5 deletions.
Binary file added docs/user/docs/sessions/files/download-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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/user/docs/sessions/files/expand-directory.png
Binary file not shown.
35 changes: 30 additions & 5 deletions docs/user/docs/sessions/files/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@
1. Navigate to the `Session` tab.
1. On the right side, select the corresponding session. Select the persistent
session to upload files into your persistent workspace. Click the
`File Browser`:
`File Browser` button:

![File Browser button](file-browser-button.png)

![Expand directory in file browser](expand-directory.png){:style="width:300px"}
1. Wait until the list of files has loaded.

![Upload button](upload-button.png)

Expand All @@ -25,7 +25,7 @@
1. Expand the directories by clicking on the directory icon (1) until you find the directories where you want to
upload your file to. Click the upload button (2) next to the directory name.

![Upload files button](upload-files-button.png){:style="width:300px"}
![Upload files button](upload-file-button.png){:style="width:300px"}

1. Now, select the file(s) to upload and confirm. The files to be uploaded are marked in green.

Expand All @@ -36,8 +36,33 @@ upload your file to. Click the upload button (2) next to the directory name.
1. The upload can take a few seconds/minutes, depending on the file size.
1. When the upload was successful, the dialog closes without error message.

=== "Download files"
<!-- prettier-ignore-end -->

# Download

<!-- prettier-ignore-start -->

1. Navigate to the `Session` tab.
1. On the right side, select the corresponding session. Select the persistent
session to download files into your persistent workspace. Click the
`File Browser` button:

![File Browser button](file-browser-button.png)

1. Wait until the list of files has loaded.

![Download button](download-button.png)

!!! info
To download files from hidden directories, e.g., the workspace
metadata, one has to expand these directories by clicking
`Show hidden files`

1. Expand the directories by clicking on the directory icon (1) until you find the directories where you want to
download your file from. Click the download button (2) next to the directory name and your browser will start the download.

![Download files button](download-file-button.png)

Documentation for "Download files" will follow soon.
1. You can see in your browser whether your download was successful.

<!-- prettier-ignore-end -->
2 changes: 2 additions & 0 deletions docs/user/docs/sessions/files/upload-button.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
SPDX-License-Identifier: Apache-2.0
Binary file removed docs/user/docs/sessions/files/upload-dialog.png
Binary file not shown.
2 changes: 2 additions & 0 deletions docs/user/docs/sessions/files/upload-file-button.png.license
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SPDX-FileCopyrightText: Copyright DB Netz AG and the capella-collab-manager contributors
SPDX-License-Identifier: Apache-2.0
Binary file not shown.

0 comments on commit 88fe091

Please sign in to comment.