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
| Field | Original Value | New Value |
|---|---|---|
| Epic Link | IGBF-2424 [ 18604 ] |
| Assignee | Ann Loraine [ aloraine ] |
| Assignee | Nowlan Freese [ nfreese ] |
| Summary | Update soft-clip page to show an example users can replicate | Update soft-clip page to show an example users can copy to check their knowledge |
| Summary | Update soft-clip page to show an example users can copy to check their knowledge | Update soft-clip page to show an example users & trainers can easily replicate |
| Rank | Ranked higher |
| Sprint | Winter 1 Dec 28 - Jan 8 [ 111 ] | Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22 [ 111, 112 ] |
| Rank | Ranked higher |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Sprint | Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22 [ 111, 112 ] | Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5 [ 111, 112, 113 ] |
| Rank | Ranked higher |
| 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 we wrote 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: * https://wiki.transvar.org/display/igbman/Soft-clipped+reads 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. |
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: * https://wiki.transvar.org/display/igbman/Soft-clipped+reads 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. |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Assignee | Nowlan Freese [ nfreese ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
| Assignee | Nowlan Freese [ nfreese ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Assignee | Nowlan Freese [ nfreese ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Sprint | Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5 [ 111, 112, 113 ] | Winter 1 Dec 28 - Jan 8, Winter 2 Jan 11 - Jan 22, Winter 3 Jan 25 - Feb 5, Winter 4 Feb 8 - Feb 19 [ 111, 112, 113, 114 ] |
| Rank | Ranked higher |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | Ready for Pull Request [ 10304 ] |
| Status | Ready for Pull Request [ 10304 ] | Pull Request Submitted [ 10101 ] |
| Status | Pull Request Submitted [ 10101 ] | Reviewing Pull Request [ 10303 ] |
| Status | Reviewing Pull Request [ 10303 ] | Merged Needs Testing [ 10002 ] |
| Status | Merged Needs Testing [ 10002 ] | Post-merge Testing In Progress [ 10003 ] |
| Resolution | Done [ 10000 ] | |
| Status | Post-merge Testing In Progress [ 10003 ] | Closed [ 6 ] |
| Assignee | Nowlan Freese [ nfreese ] |