Details
-
Type:
Documentation
-
Status: Closed (View Workflow)
-
Priority:
Minor
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:1
-
Epic Link:
-
Sprint:Spring 9, Spring 10, Summer 1
Description
There's currently no form of documentation in the User's Guide that I can find explaining the difference between FindJunctions (Top Hat) and Find Junctions. The only mention I can find of the former in the User's Guide is here in the IGB Gallery.
Task: Investigate the difference between FindJunctions (Top Hat) and Find Junctions and report your findings on this ticket. Then, create a new ticket to do the following:
- Either update the FindJunctions page of the User's Guide, or
- Create a new page in the User's Guide detailing FindJunctions (Top Hat) and how to use it in IGB.
Attachments
Issue Links
Activity
Documentation is updated and ready for review.
The difference between FindJunctions and FindJunctions (TopHat) has been explained in the documentation, and a link to the TopHat manual has been provided which will help user's better familiarize themselves with the program.
Small suggestion for Ann Loraine: Move the second picture so that it's directly underneath the instructions to run FindJunctions since it is most relevant to those steps.
Moving this to Merged, Needs Review for Dr. Loraine to look over the suggestion and decide if she'd like to implement it.
Update:
- I added an image. Image file is in Dropbox / IGB Users Guide
- Made the new image by adding the image file and callouts to a KeyNote document also in Dropbox / IGB Users Guide (KeyNote is slide show editing software from Apple)
- Moving back to "To-Do" for one more copy-editing check
I've found the new images in Dropbox (Dropbox > IGB Users Guide Art and Style Info > FindJunctions) and see that the FindJunctions page in the user's guide has been updated accordingly.
Another change request: The instructions for compiling FindJunctions on BitBucket list six optional arguments that FindJunctions jar accepts, but the user's guide only lists four. Please update the FindJunctios page in the user's guide so that all six optional arguments are listed there.
Removed CLI FindJunctions documentation from the wiki because it is redundant with the bitbucket site and replaced it with text letting the user know they can visit the bitbucket site for information on how to run FindJunctions as a command-line program.
Thank you for that change! The FindJunctions page in the user's guide looks complete to me now. Moving this ticket to Done.
This will require asking Ann Loraine for the information required.