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

Fix some minor issues with Manage Link interface

    Details

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

      Description

      Please modify the interface to match these slides: https://www.dropbox.com/s/2i45ivwfzfduh4l/ManageLink.pptx?dl=0

      Or, propose an even better design.

      Why the changes are needed:

      Currently in BioViz Connect, the "manage link" right panel display shows a text box that reports the public link, but it only shows the first 20 characters or so, and there is no way to expand the text area to see more. Also, the text box component is normally used for data entry, but users cannot edit the link. It is created for them, not edited.

      Change this so that a text box is not used. See slides.

      There are some other issues, as well:

      • The heading text "Public Link:" is blue, making it look like it is also a hyperlink, but it is not.
      • The file name and instructions to user are shown in italics. What is the meaning of italics?
      • When addressing the user or explaining the interface instructions, use plain text font. It's fine to use italics for file names, I guess, but it seems weird.

        Attachments

          Activity

          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/247/igbf-2921-fix-minor-issues-with-manage?link_source=email
          Hide
          ann.loraine Ann Loraine added a comment -

          Deployed to bvctest3.bioviz.org

          Show
          ann.loraine Ann Loraine added a comment - Deployed to bvctest3.bioviz.org
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          Change requests:

          Change request 1:

          Modify how the URL is displayed so that wrapping is done on "/" characters and so that the link fits into the available space. This means you have to over-rule the browser's native handling of text. We faced an identical problem with the Genome Dashboard, in which we needed to wrap on "_" (underscore) characters. See this commit for one way to do it: https://bitbucket.org/lorainelab/genome-dashboard/commits/2ef4c37b68fc042b2b7645c20e410fbe202c624c

          Change request 2:

          Replace the green and orange circles with a question mark icon. Make it look and behave like the questions marks on this page: https://apps.bioviz.org/.

          When users hover the mouse over the question mark, they should see:

          "Anyone with the public link can view or download this file." - when the link is public

          "No-one can download this file. Previous public links no longer work." - when the link is destroyed or never was made.

          Change request 3:

          Modify the text shown below the buttons to read:

          "Note: If you remove the link, no-one will be able to use it to download or view your file in IGB. " when button is red and reads "Remove Link".

          "Note: If you create a link, anyone can use it to download or view your file in IGB." when button is blue and reads "Create Public Link"

          Change request 4:

          Change button text "Create Public Link" to "Create Link"

          Show
          ann.loraine Ann Loraine added a comment - - edited Change requests: Change request 1: Modify how the URL is displayed so that wrapping is done on "/" characters and so that the link fits into the available space. This means you have to over-rule the browser's native handling of text. We faced an identical problem with the Genome Dashboard, in which we needed to wrap on "_" (underscore) characters. See this commit for one way to do it: https://bitbucket.org/lorainelab/genome-dashboard/commits/2ef4c37b68fc042b2b7645c20e410fbe202c624c Change request 2: Replace the green and orange circles with a question mark icon. Make it look and behave like the questions marks on this page: https://apps.bioviz.org/ . When users hover the mouse over the question mark, they should see: "Anyone with the public link can view or download this file." - when the link is public "No-one can download this file. Previous public links no longer work." - when the link is destroyed or never was made. Change request 3: Modify the text shown below the buttons to read: "Note: If you remove the link, no-one will be able to use it to download or view your file in IGB. " when button is red and reads "Remove Link". "Note: If you create a link, anyone can use it to download or view your file in IGB." when button is blue and reads "Create Public Link" Change request 4: Change button text "Create Public Link" to "Create Link"
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          Re: Change request 2: Decided it would be better to move the tooltip explaining why the link is needed next to the title "Manage Link". Displayed "public" and "private" in bold font to make these words more prominent.

          Re: Change request 3: Done, with slight re-wording. Key idea here is that we address the user directly, telling them exactly what will happen if they click the button.

          Re: Change request 4: Not doing this one. Leaving the interface as-is for now as changing the wording seems to mess up the functionality.

          Re: Change request 1: This one is hard! Leaving this for the next attempt. But it needs to be done because the text is not yet rendered properly, as it is spilling out of the box and out of the browser window.

          Branch: https://bitbucket.org/aloraine/bioviz-connect/branch/IGBF-2921

          See slide 3 for above new version:

          https://www.dropbox.com/s/2i45ivwfzfduh4l/ManageLink.pptx?dl=0

          Submitting PR.

          Show
          ann.loraine Ann Loraine added a comment - - edited Re: Change request 2: Decided it would be better to move the tooltip explaining why the link is needed next to the title "Manage Link". Displayed "public" and "private" in bold font to make these words more prominent. Re: Change request 3: Done, with slight re-wording. Key idea here is that we address the user directly, telling them exactly what will happen if they click the button. Re: Change request 4: Not doing this one. Leaving the interface as-is for now as changing the wording seems to mess up the functionality. Re: Change request 1: This one is hard! Leaving this for the next attempt. But it needs to be done because the text is not yet rendered properly, as it is spilling out of the box and out of the browser window. Branch: https://bitbucket.org/aloraine/bioviz-connect/branch/IGBF-2921 See slide 3 for above new version: https://www.dropbox.com/s/2i45ivwfzfduh4l/ManageLink.pptx?dl=0 Submitting PR.
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/249/igbf-2921-remove-round-buttons-move-help?link_source=email
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          Deployed to https://bvctest3.bioviz.org.

          Moving back to "To-Do" to address Change Request 1 (see previous comment).

          Inventory:

          [bvc_hosts]
          bvctest3 ansible_host=3.216.236.83 domain=bvctest3.bioviz.org secret_key=[redacted]
          
          [bvc_hosts:vars]
          ansible_ssh_common_args="-o StrictHostKeyChecking=no"
          ansible_python_interpreter=/usr/bin/python3
          ansible_ssh_user=ubuntu
          
          Show
          ann.loraine Ann Loraine added a comment - - edited Deployed to https://bvctest3.bioviz.org . Moving back to "To-Do" to address Change Request 1 (see previous comment). Inventory: [bvc_hosts] bvctest3 ansible_host=3.216.236.83 domain=bvctest3.bioviz.org secret_key=[redacted] [bvc_hosts:vars] ansible_ssh_common_args= "-o StrictHostKeyChecking=no" ansible_python_interpreter=/usr/bin/python3 ansible_ssh_user=ubuntu
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/250/igbf-2921-implement-change-request-4?link_source=email
          Hide
          ann.loraine Ann Loraine added a comment -

          Deployed to bvctest3.bioviz.org

          Show
          ann.loraine Ann Loraine added a comment - Deployed to bvctest3.bioviz.org
          Hide
          ann.loraine Ann Loraine added a comment -

          Please add a comment to this ticket that tells me what has changed so that I will know what to test in the new version.

          attn: Karthik Raveendran and Nowlan Freese

          Moving to "To-Do" pending further information.

          Show
          ann.loraine Ann Loraine added a comment - Please add a comment to this ticket that tells me what has changed so that I will know what to test in the new version. attn: Karthik Raveendran and Nowlan Freese Moving to "To-Do" pending further information.
          Hide
          ann.loraine Ann Loraine added a comment -

          I have reviewed the new interface. Change Request 1 is done. Moving to closed.

          Show
          ann.loraine Ann Loraine added a comment - I have reviewed the new interface. Change Request 1 is done. Moving to closed.
          Hide
          karthik Karthik Raveendran added a comment -

          Changes made in this commit are:
          1) URL word-wrap was implemented. In Firefox, a URL is wrapped at the forward-slashes but in Chrome, a URL is wrapped at the hyphens as well.
          2) Copy button was moved to the end of the URL from the "Public Link: " title area.

          Show
          karthik Karthik Raveendran added a comment - Changes made in this commit are: 1) URL word-wrap was implemented. In Firefox, a URL is wrapped at the forward-slashes but in Chrome, a URL is wrapped at the hyphens as well. 2) Copy button was moved to the end of the URL from the "Public Link: " title area.
          Hide
          ann.loraine Ann Loraine added a comment - - edited

          Issues noted:

          • During testing, we noticed that if a user removes a public link, the Manage Link interface displays the message "Not Available" as a hyperlinked text.

          Request: Do not show the "Not Available" text as this will likely make the interface more usable and also simplify the code.

          • Sometimes the Note does not appear in the Manage Link interface.

          Note: Sometimes it takes time for a public link to become private after the user clicks the "Remove Public Link" button. We discussed adding some kind of notice to the user letting them know that there might be a slight delay after removing a link before a file becomes inaccessible to the public. Suggestion: Develop some testing code that will test the accessibility of the file following removal of public access to better understand this issue.

          Show
          ann.loraine Ann Loraine added a comment - - edited Issues noted: During testing, we noticed that if a user removes a public link, the Manage Link interface displays the message "Not Available" as a hyperlinked text. Request: Do not show the "Not Available" text as this will likely make the interface more usable and also simplify the code. Sometimes the Note does not appear in the Manage Link interface. Note: Sometimes it takes time for a public link to become private after the user clicks the "Remove Public Link" button. We discussed adding some kind of notice to the user letting them know that there might be a slight delay after removing a link before a file becomes inaccessible to the public. Suggestion: Develop some testing code that will test the accessibility of the file following removal of public access to better understand this issue.
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/251/igbf-2921-fix-minor-issues-regarding?link_source=email
          Hide
          karthik Karthik Raveendran added a comment -

          Submitted pull request Commit

          This commit addresses:
          a) Removal of 'Not Available' text from public link.
          b) The Note not appearing in the Manage link interface.

          Show
          karthik Karthik Raveendran added a comment - Submitted pull request Commit This commit addresses: a) Removal of 'Not Available' text from public link. b) The Note not appearing in the Manage link interface.
          Hide
          ann.loraine Ann Loraine added a comment -

          The code looks fine, but I had some concerns. Please see comment in the code.

          Show
          ann.loraine Ann Loraine added a comment - The code looks fine, but I had some concerns. Please see comment in the code.
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/252/igbf-2921-fix-display-of-public-link-and?link_source=email
          Hide
          karthik Karthik Raveendran added a comment -

          Submitted pull request commit

          This commit addresses:
          a) Remove and add the entire public link div during toggle
          b) Remove onclick function on the copy button when it is not displayed

          Show
          karthik Karthik Raveendran added a comment - Submitted pull request commit This commit addresses: a) Remove and add the entire public link div during toggle b) Remove onclick function on the copy button when it is not displayed
          Hide
          ann.loraine Ann Loraine added a comment -

          Deployed to https://bvctest3.bioviz.org and ready for testing.

          Show
          ann.loraine Ann Loraine added a comment - Deployed to https://bvctest3.bioviz.org and ready for testing.
          Hide
          ann.loraine Ann Loraine added a comment -

          Styling change request:

          Please add vertical whitespace between the button and the Note below it. It should be the same vertical distance as the space separating the top of the button and the "is currently public" line above it.

          attn: Karthik Raveendran

          Show
          ann.loraine Ann Loraine added a comment - Styling change request: Please add vertical whitespace between the button and the Note below it. It should be the same vertical distance as the space separating the top of the button and the "is currently public" line above it. attn: Karthik Raveendran
          Hide
          karthik Karthik Raveendran added a comment -

          Submitted pull request commit

          Show
          karthik Karthik Raveendran added a comment - Submitted pull request commit
          Show
          nfreese Nowlan Freese added a comment - Merged https://bitbucket.org/nfreese/bioviz-connect/pull-requests/254/igbf-2921?link_source=email
          Hide
          ann.loraine Ann Loraine added a comment -

          Deployed and checked for styling change. It is complete. Moving to Done.

          Show
          ann.loraine Ann Loraine added a comment - Deployed and checked for styling change. It is complete. Moving to Done.

            People

            • Assignee:
              karthik Karthik Raveendran
              Reporter:
              ann.loraine Ann Loraine
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: