Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation about upload/download and fix markdown #1580

Merged
merged 9 commits into from
Dec 12, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/technical-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -453,8 +453,8 @@ Personnel have the permissions to upload data.
When starting an upload, a directory (“staging directory”) is created by the executing command. The
default location of the staging directory is the current working directory, however the user can specify
an existing directory in which the staging directory should be placed. Independent of the location
(specified or default), the staging directory is named _DataDelivery*<timestamp>*<project_id>_,
where <timestamp> is the date and time when the upload was started, and <project_id> is the ID of
(specified or default), the staging directory is named _DataDelivery\_\<timestamp\>\_\<project_id\>\_upload_,
where \<timestamp\> is the date and time when the upload was started, and \<project_id\> is the ID of
the project the user is attempting to upload data to. If there is no data to upload, this directory is
deleted immediately. If not, the staging directory will contain three subdirectories:

Expand Down Expand Up @@ -533,7 +533,7 @@ When downloading data, the Researchers can either choose to download specific fi
folder(s), or the entire project contents.

As with the upload ([Uploading data](#uploading-data)), a staging directory is created when downloading the data. This
directory is placed by default in the current working directory, and is named DataDelivery*<timestamp>*<project_id>.
directory is placed by default in the current working directory, and is named _DataDelivery\_\<timestamp\>\_\<project_id\>\_download_.
However unlike the upload command, downloading allows the user to choose the name of the directory - specifying a
destination. The destination cannot be an existing directory[^22] - it must be a new directory. Since a new destination is required with every
download, downloading the same file(s) multiple times is possible and is only limited by the amount
Expand Down
Loading