change underscores to hyphen (#790)

- edit bucket names, underscore to hyphen
- fix some wording

Author: AgentKumara

docs/Storage/Long_Term_Storage/Configuring_s3cmd.md

@@ -22,7 +22,7 @@ s3cmd --configure
 
 Enter the following details when prompted in the terminal:
 
-`Access Key`: Your NeSI user ID
+`Access Key`: Your username
 
 `Secret Key`: This is the code from the 1-time link in your Freezer allocation email. Please let us know if you need to <a href="mailto:[email protected]?subject=Reset%20Freezer%20Secret%20Key">reset this key</a>.
 
@@ -31,7 +31,7 @@ Please copy and paste the sections in <span style="color:blue">blue</span>.
 <pre><code>Enter new values or accept defaults in brackets with Enter.
 Refer to user manual for detailed description of all options.
 Access key and Secret key are your identifiers for AWS S3. Leave them empty for using the env variables.
-Access Key: <span style="color:green"><b>User ID</b></span>
+Access Key: <span style="color:green"><b>Your username</b></span>
 Secret Key: <span style="color:green"><b>Your Freezer Secret Key</b></span>
 Default Region: <span style="color:blue"><b>akl-1</b></span>
 Use "s3.amazonaws.com" for S3 Endpoint and not modify it to the target Amazon S3.

docs/Storage/Long_Term_Storage/Freezer_Guide.md

@@ -30,7 +30,7 @@ Please note that your bucket has the same name as your Freezer allocation. If yo
 List all objects in a bucket.
 
 ```sh
-s3cmd ls -r -l -H s3://<freezer_bucket>/
+s3cmd ls -r -l -H s3://<freezer-bucket>/
 ```
 
 This can also be used to list all the objects in path.
@@ -49,8 +49,8 @@ s3cmd la
 ### Storage usage by specific bucket
 
 ```sh
-s3cmd du -H s3://<freezer_bucket>
-   7G      1781 objects s3://<freezer_bucket>/
+s3cmd du -H s3://<freezer-bucket>
+   7G      1781 objects s3://<freezer-bucket>/
 ```
 
 `s3cmd du -H` without specifying a bucket is only available for project owners.
@@ -66,33 +66,33 @@ To transfer files/folders to S3 gateway to be archived. `cd` into where the file
 
 !!! warning
 
-    If you have files larger than 10TB you may need to change chunk size, please see the [Large files and Chunk Size](Other_Useful_Commands.md) section for details 
+    If you have files larger than 10TB you may need to change chunk size, please see the [Large files and chunk size](Other_Useful_Commands.md#large-files-and-chunk-size) section for details 
 
 ```sh
-s3cmd put --verbose your_file s3://<freezer_bucket>/your_directory/your_file
+s3cmd put --verbose your_file s3://<freezer-bucket>/your_directory/your_file
 ```
 
 ``` out
 INFO: Cache file not found or empty, creating/populating it.
 INFO: Compiling list of local files...
 INFO: Running stat() and reading/calculating MD5 values on 1 files, this may take some time...
 INFO: Summary: 1 local files to upload
-upload: 'your_file' -> 's3://<freezer_bucket>/your_directory/your_file'  [1 of 1]
+upload: 'your_file' -> 's3://<freezer-bucket>/your_directory/your_file'  [1 of 1]
  172202 of 172202   100% in    0s   920.89 KB/s  done
 ```
 
 or folders
 
 ```sh
-s3cmd put --recursive --verbose yourfolder s3://<freezer_bucket>/your_directory/your_folder/
+s3cmd put --recursive --verbose yourfolder s3://<freezer-bucket>/your_directory/your_folder/
 ```
 
 ``` out
 INFO: Cache file not found or empty, creating/populating it.
 INFO: Compiling list of local files...
 INFO: Running stat() and reading/calculating MD5 values on 1 files, this may take some time...
 INFO: Summary: 1 local files to upload
-upload: 'yourfolder/your_file' -> 's3://<freezer_bucket>/your_directory/your_folder/yourfolder/yourfile'  [1 of 1]
+upload: 'yourfolder/your_file' -> 's3://<freezer-bucket>/your_directory/your_folder/yourfolder/yourfile'  [1 of 1]
  172202 of 172202   100% in    0s  1691.71 KB/s  done
 ```
 
@@ -105,7 +105,7 @@ Partially uploaded files will be deleted automatically.
 Synchronize a directory tree to S3 (checks files freshness using size and md5 checksum, unless overridden by options). If you wish to have additional informative output, please use the `--verbose` flag as well.
 
 ```sh
-s3cmd sync yourfolder s3://<freezer_bucket>/your_directory/your_folder/
+s3cmd sync yourfolder s3://<freezer-bucket>/your_directory/your_folder/
 ```
 
 ### Preview or dry-run
@@ -120,54 +120,54 @@ Only shows what should be uploaded or downloaded but doesn't actually do it. May
 List contained objects/files/folders:
 
 ```sh
-s3cmd ls -l -H s3://<freezer_bucket>/your_directory/your_folder/
+s3cmd ls -l -H s3://<freezer-bucket>/your_directory/your_folder/
 ```
 
 ``` out
-                    DIR                                                    s3://<freezer_bucket>/your_directory/your_folder/MY_TEST/
-2025-06-16 23:13    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer_bucket>/your_directory/your_folder/10G_test.file
-2025-06-16 23:30    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer_bucket>/your_directory/your_folder/10G_copy.file
-2025-06-17 01:26     0   d41d8cd98f00b204e9800998ecf8427e     STANDARD     s3://<freezer_bucket>/your_directory/your_folder/1test.txt
+                    DIR                                                    s3://<freezer-bucket>/your_directory/your_folder/MY_TEST/
+2025-06-16 23:13    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer-bucket>/your_directory/your_folder/10G_test.file
+2025-06-16 23:30    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer-bucket>/your_directory/your_folder/10G_copy.file
+2025-06-17 01:26     0   d41d8cd98f00b204e9800998ecf8427e     STANDARD     s3://<freezer-bucket>/your_directory/your_folder/1test.txt
 ```
 
 or all objects recursive -r or --recursive
 
 ```sh
-s3cmd ls -r -l -H s3://<freezer_bucket>/your_directory/your_folder/
+s3cmd ls -r -l -H s3://<freezer-bucket>/your_directory/your_folder/
 ```
 
 ``` out
-2025-06-16 23:13    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer_bucket>/your_directory/your_folder/10G_test.file
-2025-06-16 23:30    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer_bucket>/your_directory/your_folder/10G_copy.file
-2025-06-17 01:31    14   95b28899a460dd8971705dfcd0f5f0d4     STANDARD     s3://<freezer_bucket>/your_directory/your_folder/MY_TEST/annotations/3/4/test3.txt
-2025-06-17 01:31    14   e76c3a8939fb031bab02a89f6fab520b     STANDARD     s3://<freezer_bucket>/your_directory/your_folder/MY_TEST/annotations/3/test2.txt
-2025-06-17 01:31    14   be2520c884c1be55bab187374a982b12     STANDARD     s3://<freezer_bucket>/your_directory/your_folder/MY_TEST/raw_data/test1.txt
-2025-06-17 01:26     0   d41d8cd98f00b204e9800998ecf8427e     STANDARD     s3://<freezer_bucket>/your_directory/your_folder/test/test.txt
+2025-06-16 23:13    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer-bucket>/your_directory/your_folder/10G_test.file
+2025-06-16 23:30    10G  8add0bf4f023e3dbd36a329d1eae5bbd-684  STANDARD     s3://<freezer-bucket>/your_directory/your_folder/10G_copy.file
+2025-06-17 01:31    14   95b28899a460dd8971705dfcd0f5f0d4     STANDARD     s3://<freezer-bucket>/your_directory/your_folder/MY_TEST/annotations/3/4/test3.txt
+2025-06-17 01:31    14   e76c3a8939fb031bab02a89f6fab520b     STANDARD     s3://<freezer-bucket>/your_directory/your_folder/MY_TEST/annotations/3/test2.txt
+2025-06-17 01:31    14   be2520c884c1be55bab187374a982b12     STANDARD     s3://<freezer-bucket>/your_directory/your_folder/MY_TEST/raw_data/test1.txt
+2025-06-17 01:26     0   d41d8cd98f00b204e9800998ecf8427e     STANDARD     s3://<freezer-bucket>/your_directory/your_folder/test/test.txt
 ```
 
 ### Restore from tape
 
 It is necessary to restore data from the tape (Glacier) prior to retrieving it. To restore file from Glacier storage:
 
 ```sh
-s3cmd restore --recursive --verbose s3://<freezer_bucket>/your_directory/data_folder/
+s3cmd restore --recursive --verbose s3://<freezer-bucket>/your_directory/data_folder/
 ```
 
 ``` out
-INFO: Retrieving list of remote files for s3://<freezer_bucket>/your_directory/your_folder/ ...
+INFO: Retrieving list of remote files for s3://<freezer-bucket>/your_directory/your_folder/ ...
 INFO: Summary: Restoring 6 remote files for 1 days at Standard priority
-restore: 's3://n<freezer_bucket>/your_directory/your_folder/10G.file'
-restore: 's3://<freezer_bucket>/your_directory/your_folder/10G_copy.file'
-restore: 's3://<freezer_bucket>/your_directory/your_folder/MY_TEST/annotations/3/4/test3.txt'
-restore: 's3://<freezer_bucket>/your_directory/your_folder/MY_TEST/annotations/3/test2.txt'
-restore: 's3://<freezer_bucket>/your_directory/your_folder/MY_TEST/raw_data/test1.txt'
-restore: 's3://<freezer_bucket>/your_directory/your_folder/test.txt'
+restore: 's3://n<freezer-bucket>/your_directory/your_folder/10G.file'
+restore: 's3://<freezer-bucket>/your_directory/your_folder/10G_copy.file'
+restore: 's3://<freezer-bucket>/your_directory/your_folder/MY_TEST/annotations/3/4/test3.txt'
+restore: 's3://<freezer-bucket>/your_directory/your_folder/MY_TEST/annotations/3/test2.txt'
+restore: 's3://<freezer-bucket>/your_directory/your_folder/MY_TEST/raw_data/test1.txt'
+restore: 's3://<freezer-bucket>/your_directory/your_folder/test.txt'
 ```
 
 By default files will remain in the S3 bucket for 1 day. If longer is required, this can be modified at the time of file restoration: 
 
 ```sh
-s3cmd restore --recursive s3://<freezer_bucket>/your_directory/data_folder/ --restore-days=1
+s3cmd restore --recursive s3://<freezer-bucket>/your_directory/data_folder/ --restore-days=1
 ```
 
 ### Get objects after restore
@@ -178,7 +178,7 @@ s3cmd restore --recursive s3://<freezer_bucket>/your_directory/data_folder/ --re
 Example to get or download the directory `data_folder` and all contained objects/files/folders:
 
 ```sh
-s3cmd get --recursive s3://<freezer_bucket>/your_directory/data_folder/
+s3cmd get --recursive s3://<freezer-bucket>/your_directory/data_folder/
 ```
 
 This will place the all files and subdirectories in the above `data_folder` into your current directory.

docs/Storage/Long_Term_Storage/Other_Useful_Commands.md

@@ -36,39 +36,39 @@ This can be set by using the flag `--multipart-chunk-size-mb=5120` to the comman
 Example: 
 
 ```sh
-s3cmd put --multipart-chunk-size-mb=1000 yourfile s3://<freezer_bucket>/your_directory/your_file/ --verbose
+s3cmd put --multipart-chunk-size-mb=1000 yourfile s3://<freezer-bucket>/your_directory/your_file/ --verbose
 ```
 
 ``` out
-upload: 'your_file' -> 's3://<freezer_bucket>/your_directory/your_file/'  [part 1 of 23, 1000MB] [1 of 1]
+upload: 'your_file' -> 's3://<freezer-bucket>/your_directory/your_file/'  [part 1 of 23, 1000MB] [1 of 1]
  1048576000 of 1048576000   100% in   25s    39.62 MB/s  done
 
 ....
 
-upload: 'your_file' -> 's3://<freezer_bucket>/your_directory/your_file/'  [part 23 of 23, 169MB] [1 of 1]
+upload: 'your_file' -> 's3://<freezer-bucket>/your_directory/your_file/'  [part 23 of 23, 169MB] [1 of 1]
  177209344 of 177209344   100% in    4s    35.90 MB/s  done
 ```
 
 ## Moving files
 To move files within a bucket:
 
 ``` sh
-s3cmd mv s3://<freezer_bucket>/your_directory/your_file.txt s3://<freezer_bucket>/other_directory/your_file.txt
+s3cmd mv s3://<freezer-bucket>/your_directory/your_file.txt s3://<freezer-bucket>/other_directory/your_file.txt
 ```
 ``` out
 
-move: 's3://<freezer_bucket>/your_directory/your_file.txt' -> 's3://<freezer_bucket>/other_directory/your_file.txt'  [1 of 1]
+move: 's3://<freezer-bucket>/your_directory/your_file.txt' -> 's3://<freezer-bucket>/other_directory/your_file.txt'  [1 of 1]
 ```
 
 ## Copying files
 To make a copy of a file within a bucket to another location:
 
 ``` sh
-s3cmd cp s3://<freezer_bucket>/your_directory/your_file.txt s3://<freezer_bucket>/your_directory/your_file_copy.txt
+s3cmd cp s3://<freezer-bucket>/your_directory/your_file.txt s3://<freezer-bucket>/your_directory/your_file_copy.txt
 ```
 
 ``` out
-remote copy: 's3://<freezer_bucket>/your_directory/your_file.txt' -> 's3://<freezer_bucket>/your_directory/your_file_copy.txt'  [1 of 1]
+remote copy: 's3://<freezer-bucket>/your_directory/your_file.txt' -> 's3://<freezer-bucket>/your_directory/your_file_copy.txt'  [1 of 1]
 ```
 
 ## Deleting data
@@ -80,13 +80,13 @@ remote copy: 's3://<freezer_bucket>/your_directory/your_file.txt' -> 's3://<free
 Data can be deleted from both the bucket (cache) and from tape (thought this is a flag to overwrite, rather than actual deletion)
 
 ```sh
-s3cmd rm s3://<freezer_bucket>/your_directory/data_folder/
+s3cmd rm s3://<freezer-bucket>/your_directory/data_folder/
 ```
 
 This command can also be used recursively.
 
 ```sh
-s3cmd rm --recursive s3://<freezer_bucket>/your_directory/data_folder/
+s3cmd rm --recursive s3://<freezer-bucket>/your_directory/data_folder/
 ```
 
 ## s3cmd reference

docs/Storage/Long_Term_Storage/Troubleshooting.md

@@ -18,12 +18,12 @@ tmux new -s freezer_transfer
 cd /nesi/nobackup/<project_id>/myproject
 
 # put data 'your_folder' into Freezer bucket
-s3cmd put --recursive --verbose your_folder s3://<freezer_bucket>/your_directory/your_folder
+s3cmd put --recursive --verbose your_folder s3://<freezer-bucket>/your_directory/your_folder
 ```
-To detatch from the current `tmux` session by:
+To detach from the current `tmux` session by:
 <kbd>ctrl</kbd> + <kbd>b</kbd>, then <kbd>d</kbd>
 
-Detatching the `tmux` session, allows you to close your primary terminal and logoff while the upload continues. 
+Detaching the `tmux` session, allows you to close your primary terminal and logoff while the upload continues. 
 
 To reattach to the session: