Details
-
Type:
Task
-
Status: To-Do (View Workflow)
-
Priority:
Minor
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:
-
Story Points:0.5
-
Epic Link:
Description
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide.
https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language
Tasks:
- Task 1. Improve the Command Socket documentation so that a user can easily locate the above page.
- Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers
I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation.
Additional comment from Ivory:
The script in the Readme of the Command Socket App is supposed to be a simple copy-and-paste job to get a script that demonstrates the functionality of the App.
The script in the Command Socket readme does not work on our linux machine.
I had to change the first line to use /bash rather than /sh.
The /bash version works fine on both linux and mac (have not explored windows yet).
This post offers some helpful explanation:
https://unix.stackexchange.com/questions/45781/shell-script-fails-syntax-error-unexpected
Attachments
Issue Links
- relates to
-
IGBF-1286 Support tilde as shorthand for HOME.DIRECTORY in snapshotmainView
-
- Closed
-
Activity
| Link | This issue relates to IGBF-1409 [ IGBF-1409 ] |
| Assignee | Ann Loraine [ aloraine ] |
| Sprint | Summer 2019 Sprint 8 [ 67 ] |
| Sprint | Summer 2019 Sprint 8 [ 67 ] |
| Rank | Ranked higher |
| Rank | Ranked higher |
| Workflow | Loraine Lab Workflow [ 18110 ] | Fall 2019 Workflow Update [ 18904 ] |
| Workflow | Fall 2019 Workflow Update [ 18904 ] | Revised Fall 2019 Workflow Update [ 21031 ] |
| Status | Open [ 1 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | To-Do [ 10305 ] |
| Rank | Ranked higher |
| Epic Link | IGBF-1908 [ 17998 ] |
| Labels | Beginner | intermediate |
| Summary | Improve Command Socket App documentation | Release App Store 2.0 |
| Sprint | Winter 5 Feb 22 - Mar 5 [ 115 ] |
| Summary | Release App Store 2.0 | Improve Command Socket Demo app |
| Description |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than whats in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language That page has a very informative child page that is currently private (you have to log in to be able to see the page at all). I don't see how any one can leverage the scripting language if they can't see this Script List. https://wiki.transvar.org/display/igbman/IGB+Script+List * Task 1 - figure out why the Script List page is not already public (maybe these commands have not yet been implemented in the app?) This will be hardest part, it may require testing each of these commands, and/or tracking down old related documentation. * Task 2 - Make sure all of the relevant information a user would need to use all the features in the Command Socket App are publicly available. (might be as easy as making the Script List page public) * Task 3 - Edit the Command Socket App readme to direct users in finding the complete documentation for the IGB scripting language. * Task 4 - improve the example script. I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. This is a beginner issue BUT with these added notes: * Editing, or even reading, the Script List page requires current log in credentials. * Changes to the readme in the Command Socket App are published independently from new IGB releases. |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language Tasks: * Task 1. Improve the Command Socket documentation so that a user can easily locate the above page. * Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. |
| Sprint | Winter 5 Feb 22 - Mar 5 [ 115 ] | Winter 6 Mar 8 - Mar 19 [ 116 ] |
| Description |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language Tasks: * Task 1. Improve the Command Socket documentation so that a user can easily locate the above page. * Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language Tasks: * Task 1. Improve the Command Socket documentation so that a user can easily locate the above page. * Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. Additional comment from reporter: {quote} The script in the Readme of the Command Socket App is supposed to be a simple copy-and-paste job to get a script that demonstrates the functionality of the App. The script in the Command Socket readme does not work on our linux machine. I had to change the first line to use /bash rather than /sh. The /bash version works fine on both linux and mac (have not explored windows yet). This post offers some helpful explanation: https://unix.stackexchange.com/questions/45781/shell-script-fails-syntax-error-unexpected {quote} |
| Description |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language Tasks: * Task 1. Improve the Command Socket documentation so that a user can easily locate the above page. * Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. Additional comment from reporter: {quote} The script in the Readme of the Command Socket App is supposed to be a simple copy-and-paste job to get a script that demonstrates the functionality of the App. The script in the Command Socket readme does not work on our linux machine. I had to change the first line to use /bash rather than /sh. The /bash version works fine on both linux and mac (have not explored windows yet). This post offers some helpful explanation: https://unix.stackexchange.com/questions/45781/shell-script-fails-syntax-error-unexpected {quote} |
Right now the Command Socket App invites new users into dead ends. It gives an example script, but that script saves the example images to a folder that may not be intuitive to our users. If the user does get the example working, and wants to learn more, they are not given any hints about what to look for, and there is nothing to indicate that the scripting language CAN do more than what is in the example.
We have page in the users guide that gives more detail about the scripting language. I think this detail is deliberately left out of the readme for the command socket to avoid duplication (avoid having multiple places to update if changes are made). But the readme should still direct users to the documentation in the users guide. https://wiki.transvar.org/display/igbman/Scripting+and+the+IGB+command+language Tasks: * Task 1. Improve the Command Socket documentation so that a user can easily locate the above page. * Task 2. Improve the example script to ensure that it can run on Windows computers in addition to MacOS and Linux computers I think replacing the current example script (in the Command Socket App readme) with the one I have attached to this issue will cover tasks 3 and 4. It removes all of the special characters from the file names (consider changing snapshotmainView to snapshot command). It saves the example images to a more readily accessed directory (need to make sure this path works on Windows and Linux). And it adds comments about how to reach the more complete documentation. Additional comment from Ivory: {quote} The script in the Readme of the Command Socket App is supposed to be a simple copy-and-paste job to get a script that demonstrates the functionality of the App. The script in the Command Socket readme does not work on our linux machine. I had to change the first line to use /bash rather than /sh. The /bash version works fine on both linux and mac (have not explored windows yet). This post offers some helpful explanation: https://unix.stackexchange.com/questions/45781/shell-script-fails-syntax-error-unexpected {quote} |
| Sprint | Winter 6 Mar 8 - Mar 19 [ 116 ] |