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

Create BioViz Connect User's Guide

    Details

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

      Description

      Situation: BioViz Connect has developer documentation, but no user's guide.

      Task: Create a BioViz Connect user's guide on Confluence in a similar style to IGB.

      https://wiki.bioviz.org/confluence/display/bcguide/Home

        Attachments

          Issue Links

            Activity

            Hide
            nfreese Nowlan Freese added a comment -

            Note that the current production version of BioViz Connect is currently over a year behind the master branch. We should be able to push the changes to production early next week. Until then, any images or workflows would need to be created/verified on one of the test servers.

            Show
            nfreese Nowlan Freese added a comment - Note that the current production version of BioViz Connect is currently over a year behind the master branch. We should be able to push the changes to production early next week. Until then, any images or workflows would need to be created/verified on one of the test servers.
            Hide
            nfreese Nowlan Freese added a comment -

            Test servers:
            https://bvctest3.bioviz.org/
            https://bvctest7.bioviz.org/

            Note that these servers turn off at 6pm Eastern, but Nowlan Freese can turn them on.

            Show
            nfreese Nowlan Freese added a comment - Test servers: https://bvctest3.bioviz.org/ https://bvctest7.bioviz.org/ Note that these servers turn off at 6pm Eastern, but Nowlan Freese can turn them on.
            Hide
            nfreese Nowlan Freese added a comment - - edited

            Quick Start
            Sign In to BioViz Connect
            Navigation
            Add Metadata
            Create Public Links
            Analyses
            Search
            View in IGB
            Troubleshooting

            Show
            nfreese Nowlan Freese added a comment - - edited Quick Start Sign In to BioViz Connect Navigation Add Metadata Create Public Links Analyses Search View in IGB Troubleshooting
            Hide
            ann.loraine Ann Loraine added a comment -

            Plan: Use bvctest3.bioviz.org for user's guide development.

            Show
            ann.loraine Ann Loraine added a comment - Plan: Use bvctest3.bioviz.org for user's guide development.
            Show
            rweidenh Logan Weidenhammer (Inactive) added a comment - Working documents for User Guide content: https://docs.google.com/document/d/1OcQ4YCkDNFvoGULYFjxQi8y6DZasX8SFA8tJYJURNx0/edit?usp=sharing
            Hide
            rweidenh Logan Weidenhammer (Inactive) added a comment -

            Content is complete. Currently being moved over to https://wiki.bioviz.org/confluence/display/bcguide/Home

            Show
            rweidenh Logan Weidenhammer (Inactive) added a comment - Content is complete. Currently being moved over to https://wiki.bioviz.org/confluence/display/bcguide/Home
            Hide
            nfreese Nowlan Freese added a comment -

            Google Slides with images and callouts for the BioViz Connect User's Guide: https://docs.google.com/presentation/d/1KMHydVt9o7n1UtuA2_GtJxPfHHGK31CiTkWwFZvCWIY/edit?usp=sharing

            Show
            nfreese Nowlan Freese added a comment - Google Slides with images and callouts for the BioViz Connect User's Guide: https://docs.google.com/presentation/d/1KMHydVt9o7n1UtuA2_GtJxPfHHGK31CiTkWwFZvCWIY/edit?usp=sharing
            Hide
            karthik Karthik Raveendran added a comment -

            The User's Guide seems to be good. I was wondering in Sign in to BioViz Connect page if we should mention that paid Cyverse subscription is not required to use Bioviz Connect.

            Show
            karthik Karthik Raveendran added a comment - The User's Guide seems to be good. I was wondering in Sign in to BioViz Connect page if we should mention that paid Cyverse subscription is not required to use Bioviz Connect.
            Hide
            ann.loraine Ann Loraine added a comment -

            I think the details about subscriptions do not need to be added to the user's guide. It's more detail than is needed.

            Show
            ann.loraine Ann Loraine added a comment - I think the details about subscriptions do not need to be added to the user's guide. It's more detail than is needed.

              People

              • Assignee:
                nfreese Nowlan Freese
                Reporter:
                nfreese Nowlan Freese
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: