Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-1268

List User Guide pages that need update

        Details

        • Type: Task
        • Status: Closed (View Workflow)
        • Priority: Major
        • Resolution: Done
        • Affects Version/s: None
        • Fix Version/s: None
        • Labels:

          Description

          Review the list of changes made as part of 9.0.1 and later versions.

          For each issue, look for relevant pages in the users guide.
          https://wiki.transvar.org/display/igbman/Home

          Make a note in the Comments below to indicate which pages need to be updated.

            Attachments

              Issue Links

              relates to

              Task - A task that needs to be done. IGBF-2516 Update user guide pages

              • Minor - Minor loss of function, or other problem where easy workaround is present.
              • Closed

              Task - A task that needs to be done. IGBF-2526 Create new user guide page in Annotation Tracks

              • Minor - Minor loss of function, or other problem where easy workaround is present.
              • Closed

              Task - A task that needs to be done. IGBF-2527 Create Log page in User's Guide Tabbed Panels

              • Minor - Minor loss of function, or other problem where easy workaround is present.
              • Closed

                Activity

                Ascending order - Click to sort in descending order
                ieclabau Ivory Blakley (Inactive) created issue -
                ann.loraine Ann Loraine made changes -
                Field Original Value New Value
                Assignee Ann Loraine [ aloraine ]
                ann.loraine Ann Loraine made changes -
                Sprint B - Summer 2018 [ 48 ]
                ann.loraine Ann Loraine made changes -
                Rank Ranked higher
                ann.loraine Ann Loraine made changes -
                Summary Make a list of pages in the Users Guide that need update List User Guide pages that need update
                ann.loraine Ann Loraine made changes -
                Rank Ranked higher
                ann.loraine Ann Loraine made changes -
                Workflow Loraine Lab Workflow [ 17959 ] Fall 2019 Workflow Update [ 18850 ]
                ann.loraine Ann Loraine made changes -
                Workflow Fall 2019 Workflow Update [ 18850 ] Revised Fall 2019 Workflow Update [ 20975 ]
                Status Open [ 1 ] In Progress [ 3 ]
                ann.loraine Ann Loraine made changes -
                Epic Link IGBF-1765 [ 17855 ]
                ann.loraine Ann Loraine made changes -
                Story Points 3
                ann.loraine Ann Loraine made changes -
                Description Review the list of changes made as part of 9.0.1.
                https://wiki.transvar.org/display/ITD/9.0.1
                For each issue, look for relevant pages in the users guide.
                https://wiki.transvar.org/display/igbman/Home

                Checking for relevant pages in the user guide should be part of our process for every change, but it hasn't been.

                Our current testing process does not include any step to very the instructions in the current users guide--but it really should. To that end: Each module in the release testing documentation (https://wiki.transvar.org/display/ITD/IGB+Release+Documentation) should be edited to include links to the relevant user-guide pages. While testing, testers should also refer to the instructions given in the user guide to make that document is consistent with the software, check that all links still work, etc.

                Main task:
                Make a new set of jira issues for any/all updates needed for the users guide.
                		Review the list of changes made as part of 9.0.1 and later versions.

                * https://wiki.transvar.org/display/ITD/9.0.1
                * https://wiki.transvar.org/display/ITD/9.0.2
                * https://wiki.transvar.org/display/ITD/9.1.0

                For each issue, look for relevant pages in the users guide.
                https://wiki.transvar.org/display/igbman/Home

                Make a note in the Comments below to indicate which pages need to be updated.

                ann.loraine Ann Loraine made changes -
                Labels Beginner
                ann.loraine Ann Loraine made changes -
                Story Points 3 5
                ann.loraine Ann Loraine made changes -
                Status In Progress [ 3 ] To-Do [ 10305 ]
                gchamma Jay Chamma (Inactive) made changes -
                Sprint Summer 5: 3 Aug - 14 Aug [ 100 ]
                gchamma Jay Chamma (Inactive) made changes -
                Assignee Jay Chamma [ gchamma ]
                gchamma Jay Chamma (Inactive) made changes -
                Status To-Do [ 10305 ] In Progress [ 3 ]
                gchamma Jay Chamma (Inactive) made changes -
                Story Points 5 1
                ann.loraine Ann Loraine made changes -
                Sprint Summer 5: 3 Aug - 14 Aug [ 100 ] Summer 5: 3 Aug - 14 Aug, Summer 6: 17 Aug - 28 Aug [ 100, 101 ]
                ann.loraine Ann Loraine made changes -
                Rank Ranked higher
                Hide
                Permalink
                gchamma Jay Chamma (Inactive) added a comment - - edited

                Needed changes:

                1) in About annots.xml section of the User Guide, it says that “do not include a leading "#" character.” for the hexadecimal code of color.
                In IGBF-1237, that was changed so IGB is able tolerate # in color specifications.

                2) Out dated screen shot of right-click menu in Annotation Track Operations section. Also, there is no section explaining the “Filter..” option.

                • The “Color By..“ option is explained in its own section, and the same thing should be done for the “Filter..” option.

                3) Some screenshots have the outdated Data Management Table text that is aligned to the right side instead of left

                4) Add information regarding the "Edit.." function in the App Repository tab

                5) Add Information regarding console tab

                6) Update screen shot of data Sources to reflect changes of removing the refresh icon

                7) Add information regarding the newly added info button in the Data Source tab

                -----------------------------------------------------------------------------------------------------------------------------

                Possible needed changes without corresponding JIRA tickets:

                1) Help --> Tutorial, does this feature still exists?

                2) Is this supposed to say IGB 6.7.1 ?? Or should it be the current version?

                Show
                gchamma Jay Chamma (Inactive) added a comment - - edited Needed changes: 1) in About annots.xml section of the User Guide, it says that “do not include a leading "#" character.” for the hexadecimal code of color. In IGBF-1237 , that was changed so IGB is able tolerate # in color specifications. Ticket related: https://jira.transvar.org/browse/IGBF-1237 Page in need of editing: https://wiki.transvar.org/display/igbman/About+annots.xml 2) Out dated screen shot of right-click menu in Annotation Track Operations section. Also, there is no section explaining the “Filter..” option. The “Color By..“ option is explained in its own section, and the same thing should be done for the “Filter..” option. Ticket related: https://jira.transvar.org/browse/IGBF-1204 Page in need of editing: https://wiki.transvar.org/display/igbman/Annotation+track+operations 3) Some screenshots have the outdated Data Management Table text that is aligned to the right side instead of left Ticket related: https://jira.transvar.org/browse/IGBF-1131 Page in need of editing: https://wiki.transvar.org/display/igbman/Loading+data https://wiki.transvar.org/display/igbman/Data+Access https://wiki.transvar.org/display/igbman/FindJunctions 4) Add information regarding the "Edit.." function in the App Repository tab Ticket related: https://jira.transvar.org/browse/IGBF-2012 Page in need of editing: https://wiki.transvar.org/display/igbman/App+Repositories 5) Add Information regarding console tab Ticket related: https://jira.transvar.org/browse/IGBF-1864 Page in need of editing: https://wiki.transvar.org/display/igbman/Tabbed+panels 6) Update screen shot of data Sources to reflect changes of removing the refresh icon Page in need of editing: https://wiki.transvar.org/display/igbman/Data+Sources+Tab Ticket related: https://jira.transvar.org/browse/IGBF-1268 7) Add information regarding the newly added info button in the Data Source tab Ticket related: https://jira.transvar.org/browse/IGBF-1506 Page in need of editing: https://wiki.transvar.org/display/igbman/Data+Sources+Tab ----------------------------------------------------------------------------------------------------------------------------- Possible needed changes without corresponding JIRA tickets: 1) Help --> Tutorial, does this feature still exists? Page in need of editing: https://wiki.transvar.org/display/igbman/Interactive+tutorials Also wiki page has a typo “instructions on on what to do” 2) Is this supposed to say IGB 6.7.1 ?? Or should it be the current version? Page in question: https://wiki.transvar.org/display/igbman/IGB+6.7.1+running+in+iPlant+Atmosphere
                gchamma Jay Chamma (Inactive) made changes -
                Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
                gchamma Jay Chamma (Inactive) made changes -
                Assignee Jay Chamma [ gchamma ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Assignee Philip Badzuh [ pbadzuh ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Link This issue relates to IGBF-2516 [ IGBF-2516 ]
                Hide
                Permalink
                pbadzuh Philip Badzuh (Inactive) added a comment -

                The suggested changes look good. I have created a new ticket to add them to the user guide in IGBF-2516. Moving into done, as there is nothing to merge.

                Show
                pbadzuh Philip Badzuh (Inactive) added a comment - The suggested changes look good. I have created a new ticket to add them to the user guide in IGBF-2516 . Moving into done, as there is nothing to merge.
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Resolution Done [ 10000 ]
                Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
                pbadzuh Philip Badzuh (Inactive) made changes -
                Assignee Philip Badzuh [ pbadzuh ] Jay Chamma [ gchamma ]
                ssegu Sai Supreeth Segu (Inactive) made changes -
                Link This issue relates to IGBF-2526 [ IGBF-2526 ]
                ssegu Sai Supreeth Segu (Inactive) made changes -
                Link This issue relates to IGBF-2527 [ IGBF-2527 ]

                  People

                  • Assignee:
                    gchamma Jay Chamma (Inactive)
                    Reporter:
                    ieclabau Ivory Blakley (Inactive)
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    3 Start watching this issue

                    Dates

                    • Created:
                      Updated:
                      Resolved: