Details
-
Type:
Documentation
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:5
-
Epic Link:
-
Sprint:Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 7 2022 Nov 21
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.
Attachments
Issue Links
Activity
| Field | Original Value | New Value |
|---|---|---|
| Epic Link | IGBF-2376 [ 18533 ] |
| Issue Type | Task [ 3 ] | Documentation [ 12 ] |
| Sprint | Fall 5 2022 Oct 24 [ 157 ] |
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.
Quick Start
Sign In to BioViz Connect
Navigation
Add Metadata
Create Public Links
Analyses
Search
View in IGB
Troubleshooting
| 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/Quick+start |
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 |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
Plan: Use bvctest3.bioviz.org for user's guide development.
| Status | In Progress [ 3 ] | To-Do [ 10305 ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Sprint | Fall 5 2022 Oct 24 [ 157 ] | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7 [ 157, 158 ] |
| Rank | Ranked higher |
Working documents for User Guide content:
https://docs.google.com/document/d/1OcQ4YCkDNFvoGULYFjxQi8y6DZasX8SFA8tJYJURNx0/edit?usp=sharing
| Assignee | Logan Weidenhammer [ rweidenh ] | Nowlan Freese [ nfreese ] |
Content is complete. Currently being moved over to https://wiki.bioviz.org/confluence/display/bcguide/Home
Google Slides with images and callouts for the BioViz Connect User's Guide: https://docs.google.com/presentation/d/1KMHydVt9o7n1UtuA2_GtJxPfHHGK31CiTkWwFZvCWIY/edit?usp=sharing
| Assignee | Nowlan Freese [ nfreese ] | Logan Weidenhammer [ rweidenh ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Assignee | Logan Weidenhammer [ rweidenh ] |
| Sprint | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7 [ 157, 158 ] | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 7 2022 Nov 21 [ 157, 158, 159 ] |
| Rank | Ranked higher |
| Sprint | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 7 2022 Nov 21 [ 157, 158, 159 ] | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 8 2022 Dec 5 [ 157, 158, 160 ] |
| Sprint | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 8 2022 Dec 5 [ 157, 158, 160 ] | Fall 5 2022 Oct 24, Fall 6 2022 Nov 7, Fall 7 2022 Nov 21 [ 157, 158, 159 ] |
| Rank | Ranked lower |
| Assignee | Karthik Raveendran [ karthik ] |
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.
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | Needs 1st Level Review [ 10005 ] |
| 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 ] | To-Do [ 10305 ] |
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Status | First Level Review in Progress [ 10301 ] | To-Do [ 10305 ] |
| Assignee | Karthik Raveendran [ karthik ] |
I think the details about subscriptions do not need to be added to the user's guide. It's more detail than is needed.
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| 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 ] |
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.