Skip to content

Add user guide#13

Merged
tomlunderwood merged 3 commits intomainfrom
PSDI-446-add-user-guide
May 16, 2025
Merged

Add user guide#13
tomlunderwood merged 3 commits intomainfrom
PSDI-446-add-user-guide

Conversation

@tomlunderwood
Copy link
Collaborator

I converted the user guide for this tool which was on Confluence (at https://stfc.atlassian.net/wiki/spaces/P/pages/865370176/User+Guide+for+the+Data+Transfer+Tools+Container+Toolbox) into markdown and added it to this repository as USERGUIDE.md. Moreover, I modified the README.md to reflect this change.

Note that the user guide (even the Confluence version) still needs some work done, in particular the 'Using the container: Other Available Data Transfer Tools and Commands' section. I have highlighted this in the user guide.

This PR closes Jira issue https://stfc.atlassian.net/browse/PSDI-446

@tomlunderwood tomlunderwood requested a review from amali-pawula May 9, 2025 14:43
USERGUIDE.md Outdated
```
docker exec data-transfer-container s3cmd put <file-path-to-upload> s3://<bucket-name>
```
*<file path to upload> -> ex: /data/<file name>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line needs to be displayed like this --> <file path to upload> -> ex: /data/<file name> but in the document I can see like this --> * -> ex: /data/ (with out <file path to upload>)

Maybe we have to use the " ` " symbol rather than the " * "symbol

This needs to apply to all other places as well 😁

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've amended the text significantly in response to this. In fact, I've done more than you asked. I've added a little more text around the commands which had <file path to upload> -> ex: /data/<file name> to help it read better. Moreover I've changed, e.g. <file name> and <file path to upload>, so that it reflects the conventions given earlier in the document, e.g. that the directory on the host is <host-data-dir>.

If you are not happy with my changes then note that the section Using the container: Other Available Data Transfer Tools and Commands will have to be looked at again anyway- to double-check that the commands are correct (after my changes). I will make a Jira ticket to do this. Since it will be looked at again for this ticket, there will be the opportunity to change anything you don't like about it, including anything I have done in this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for these modifications, Tom. I like these changes, and I don't have any objections regarding these changes. So I'm approving this PR now.

@tomlunderwood tomlunderwood merged commit b799686 into main May 16, 2025
2 checks passed
@tomlunderwood tomlunderwood deleted the PSDI-446-add-user-guide branch May 16, 2025 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants