Skip to content

Commit

Permalink
Merge pull request #1055 from DSD-DBS/docs-download-files
Browse files Browse the repository at this point in the history
docs: Up-/ Download files from workspace
  • Loading branch information
MoritzWeber0 authored Oct 13, 2023
2 parents 772b922 + 88fe091 commit 263058e
Show file tree
Hide file tree
Showing 13 changed files with 36 additions and 19 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.
Binary file modified docs/user/docs/sessions/files/files-to-upload.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 34 additions & 19 deletions docs/user/docs/sessions/files/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,22 @@
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` button:
`File Browser` button:

![File browser button](file-browser-button.png){:style="width:400px"}
![File Browser button](file-browser-button.png)

1. Wait until the file-tree has loaded.
1. Wait until the list of files has loaded.

![File browser dialog](upload-dialog.png){:style="width:300px"}

!!! info
Hidden directories (e.g., the `.metadata` directory) are not
visible by default. You can make them visible by clicking on
the `Show hidden files` checkbox.

1. You can expand the directories by clicking on the "directory" icon:

![Expand directory in file browser](expand-directory.png){:style="width:300px"}

=== "Upload files"
![Upload button](upload-button.png)

!!! info
It is currently only possible to upload files with a file size of less than 30MB.
For larger files we recommend a data transfer via Git.

1. Click the `Upload` button on the directory you want to place the file in.
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 @@ -46,8 +36,33 @@
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 -->
Binary file added docs/user/docs/sessions/files/upload-button.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/user/docs/sessions/files/upload-dialog.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 263058e

Please sign in to comment.