Details
-
Type:
Improvement
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:0.5
-
Epic Link:
-
Sprint:Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5, Winter 4 Feb 8 - Feb 19
Description
User's guides are more helpful when the user can easily replicate the images shown in the guide. This helps them double-check that what they are doing in their IGB interface is correct.
Also, when giving demos, it would be nice to be able to visit the relevant page in the IGB user's guide and show users how to re-create the images being shown there.
Unfortunately, we can't do this for the soft-clip user's guide page. This is because the page was created before we had good demonstration datasets available to teach users about the feature. Now that we have a "genome in the bottle" quickload site, let's update the documentation to use an example a user can replicate, using publicly available data.
The documentation is here:
When updating the page, be sure to provide sufficient instructions so that somebody attempting to demonstrate the new feature can easily find the location being shown in the pictures.
Attachments
Activity
Would it be possible to find an example that does not depend on our testing infrastructure? It is very possible we will move the testing file somewhere else, change its name, move it out of the S3, or reconfigure our testing infrastructure in some other way as a part of a general improvement. If we do that, the link on the user's guide will break. What we need is something that will be easy to maintain and not break.
I added the two files as attachments to the user's guide page and updated the text accordingly.
I tracked down the original file from which the data were taken and included a link in the data section at the bottom of the user's guide page.
I have updated the user's guide with instructions on how to reproduce the current images using our smokeTesting file.