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 for Cyberduck iRODS client #1857
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking good, sorry for taking my time in getting to review. I had some small requests for changes.
Also, can you open an issue regarding adding this documentation? I try not to merge any pr:s not related to issues anymore, as having issues makes them much easier to track later on.
donate to the project by making a one-time license key purchase. | ||
|
||
2. Download the SODAR iRODS connection profile: | ||
:download:`iRODS (CUBI SODAR).cyberduckprofile <_static/ext_tool_cyberduck/iRODS (CUBI SODAR).cyberduckprofile>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should replace sodar.bihealth.org
in the profile with some placeholder host name and instruct the user to edit that to match the SODAR instance they used. This documentation can be read by users of other instances as well.
(..and before you say it: yes, there is other very CUBI/BIH specific stuff in the manual. We will also deal with that in time, see #1746)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will need to take new screenshots as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's OK if those screenshots have our hostname in them, just let the reader know it's used as an example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, will merge.
Cyberduck is the only GUI iRODS client I know of. This documentation change adds a connection profile geared towards our SODAR instance and describes the usage with screenshots. Using Cyberduck should be the preferred recommendation for GUI users over the existing WebDAV via WinSCP route we already have documentation for.