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 for Cyberduck iRODS client #1857

Merged
merged 2 commits into from Mar 21, 2024
Merged

add documentation for Cyberduck iRODS client #1857

merged 2 commits into from Mar 21, 2024

Conversation

sellth
Copy link
Contributor

@sellth sellth commented Jan 4, 2024

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.

@sellth sellth requested a review from mikkonie January 4, 2024 13:00
@sellth sellth added the documentation Improvements or additions to documentation label Jan 4, 2024
Copy link
Contributor

@mikkonie mikkonie left a 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.

docs_manual/source/ext_tool_cyberduck.rst Outdated Show resolved Hide resolved
docs_manual/source/ext_tool_cyberduck.rst Outdated Show resolved Hide resolved
docs_manual/source/ext_tool_cyberduck.rst Show resolved Hide resolved
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>`
Copy link
Contributor

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)

Copy link
Contributor Author

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.

Copy link
Contributor

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.

docs_manual/source/ext_tool_cyberduck.rst Outdated Show resolved Hide resolved
@sellth sellth linked an issue Mar 15, 2024 that may be closed by this pull request
Copy link
Contributor

@mikkonie mikkonie left a 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.

@mikkonie mikkonie merged commit 20e26d9 into dev Mar 21, 2024
5 checks passed
@mikkonie mikkonie deleted the cyberduck branch March 21, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation for Cyberduck iRODS access
2 participants