More taylored instructions for iBridges #45
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jelletreep
requested changes
Aug 28, 2024
There was a problem hiding this comment.
Great manual! I do suggest to separate the GUI from the CLI instruction since it will create more focused and short manuals. I doubt whether have a combined introduction with then two subpages or two entire separate pages. What do you think @chStaiger ?
docs/manuals/ibridges.qmd
Outdated
|
|
||
| iBridges is already installed on many SURF ResearchCloud workspaces developed by Utrecht University. You can check if it is present by simply typing the following command on your terminal: `ibridges`. If iBridges is installed, this should show you the program's help menu. | ||
|
|
||
| If you need to install iBridges, you can execute: `pip install ibridges`. | ||
| - If you need to install iBridges, you can execute: `pip install ibridges`. | ||
| - On desktop workspaces you can execute: `pip install ibridgesgui`. | ||
|
|
||
| ### Creating an iRODS environment file |
There was a problem hiding this comment.
I suggest having separate pages for instructions for the gui and for python/CLI. Should we create two separate manuals? Or have one with the sections above here, and then have two links here to ibridges GUI and ibridges CLI/python?
There was a problem hiding this comment.
I think one page is enough. But indeed we should create two distinct main sections on that page.
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
Co-authored-by: Jelle Treep <[email protected]>
jelletreep
reviewed
Sep 2, 2024
docs/manuals/ibridges.qmd
Outdated
|
|
||
| To start the GUI application you would then need to open a terminal and type in `ibridges-gui`. | ||
|
|
||
| Please contact us if you need to install iBridges or if you have any trouble with the installation. |
There was a problem hiding this comment.
Suggested change
| Please contact us if you need to install iBridges or if you have any trouble with the installation. | |
| Please contact us if you need help with installing iBridges or if you want to have iBridges preinstalled on your workspace. |
jelletreep
approved these changes
Sep 5, 2024
docs/manuals/ibridges.qmd
Outdated
| #### Connect to iRODS or Yoda not hosted by Utrecht University | ||
| #### What shall I do if iBridges is not on my workspace? | ||
|
|
||
| If you are confident with python and git you can install the packages: |
There was a problem hiding this comment.
Suggested change
| If you are confident with python and git you can install the packages: | |
| If your workspace has python installed, you can install the packages using the command line (or aka terminal): |
jelletreep
force-pushed
the
ibridges-doc
branch
from
28e9c6f
to
8bbf0d7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is complete, but maybe not so nice to read yet ...