Update iRODS documentation to align with irods4j refactor

[korydraughn]

• Depends on Update support for iRODS cyberduck#17341

[korydraughn]

Will squash to one commit once approved.

[korydraughn]

Given the questions on the profile PR, I'm starting to think we need to add a note about the profile requiring the user to update it before use.

Thoughts?

[dkocher]

Given the questions on the profile PR, I'm starting to think we need to add a note about the profile requiring the user to update it before use.

Thoughts?

It should definitely be documented which properties are required to be customized and we will not be able to publish a profile requiring customization through Preferences → Profiles.

[korydraughn]

If requiring customization of the profile is a blocker, that suggests the user has to write the profile themselves - i.e. the documentation needs to list the required properties and also provide a skeleton profile for readers to copy.

Is that correct? Is there an alternative?

[korydraughn]

@dkocher Any thoughts on my previous comment?

[dkocher]

If requiring customization of the profile is a blocker, that suggests the user has to write the profile themselves - i.e. the documentation needs to list the required properties and also provide a skeleton profile for readers to copy.

Is that correct? Is there an alternative?

That is correct. We will not be able to distribute the profiles for selection in the user interface. The alternative is to prompt the user for input on missing configuration options. We do this for example for profiles using OAuth when the Client ID or Client Secret is missing ¹.

Footnotes

1. https://github.com/iterate-ch/cyberduck/blob/78e0b63d15908f05508062cb24ba536809647a3d/oauth/src/main/java/ch/cyberduck/core/oauth/OAuth2AuthorizationService.java#L419-L435 ↩

[korydraughn]

Okay. I'm going to update the documentation to show the full profile for copy-paste purposes.

Are Cyberduck users familiar with how to add a profile to their profile directory?
Is that documented somewhere? I'd like to link to that page/section to avoid duplication.

[korydraughn]

Added section which shows the connection profile template in full (i.e. copied from iterate-ch/profiles#163).

Adjusted wording too.

[dkocher]

@korydraughn Can you please fix the spelling error reported.

[korydraughn]

Fixed spelling error reported by GHAs.

Awaiting feedback and signal to squash commits so that this can move forward.

[korydraughn]

@dkocher I fixed the reported spelling error.

I think everything is ready now. Just need to see the GitHub Actions pass.

Once those pass, I'll squash the commits so the history is clean.

[korydraughn]

Here's a screenshot of the rendered documentation.

[korydraughn]

Squashed commits down to one.

All review comments have been addressed.

I think this is ready.