Details
-
Type:
Documentation
-
Status: Closed (View Workflow)
-
Priority:
Major
-
Resolution: Done
-
Affects Version/s: None
-
Fix Version/s: None
-
Labels:None
-
Story Points:2
-
Epic Link:
-
Sprint:Spring 6, Spring 7
Description
Add documentation for the GenArk and UCSC Rest. Things to include: a brief description of what the feature does, resources it uses, issues faced, and solutions for the issues.
Attachments
Issue Links
- relates to
-
IGBF-4110 Add documentation for the Genome Dynamic Search UI
-
- Closed
-
Activity
| Field | Original Value | New Value |
|---|---|---|
| Status | To-Do [ 10305 ] | In Progress [ 3 ] |
| Epic Link | IGBF-140 [ 14594 ] |
| Issue Type | Task [ 3 ] | Documentation [ 12 ] |
| Sprint | Spring 6 [ 215 ] | Spring 6, Spring 7 [ 215, 216 ] |
| Rank | Ranked higher |
| Story Points | 1 | 2 |
| Status | In Progress [ 3 ] | Needs 1st Level Review [ 10005 ] |
| Assignee | Jaya Sravani Sirigineedi [ jsirigin ] |
| Status | Needs 1st Level Review [ 10005 ] | First Level Review in Progress [ 10301 ] |
| Assignee | Paige Kulzer [ pkulzer ] |
The UCSC and GenArk documentation was really well done. The motivation for each project was clear and the overview of the methodology was concise but descriptive and easy to follow. I think it's really valuable that Sravani is writing this documentation so that future developers have a launch point for similar projects.
I left a few comments on the documentation for Sravani but I think most important will be for her to think of all the hitches she ran into during each of these projects and describe how she overcame them. She started doing this on the UCSC documentation but if there were any problems/solutions encountered during the GenArk app implementation, then I think this would be a great place to outline them!
Paige Kulzer I have added the sequence diagram for figure ideas as we discussed.
Jaya Sravani Sirigineedi I'm not seeing the diagram in either of the linked files or their parent folders. Where should I look?
Paige Kulzer It was added to the document in my Google Drive, and now I have added it to the Lorainelab drive doc. You should be able to see it at: https://docs.google.com/document/d/1g37c3BSCTI1Lg8ANAkxE7rX9Ys1rJN78URQ8JZRAlvA/edit?usp=sharing.
Thank you, I see it in the shared doc now! This looks great, thank you Jaya Sravani Sirigineedi for all of your work on this ticket.
Moving to DONE.
| 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 | Paige Kulzer [ pkulzer ] | Jaya Sravani Sirigineedi [ jsirigin ] |
| Link | This issue relates to IGBF-4203 [ IGBF-4203 ] |
Completed the documentation for both the integrations and added them to the loraine lab space. Below are the links for them.
UCSC REST - https://docs.google.com/document/d/1QGo_TG0eIlZUmB5q36Jg6p4wkYKzc_zf1juAFTJdEf0/edit?usp=sharing
GenArk - https://docs.google.com/document/d/1g37c3BSCTI1Lg8ANAkxE7rX9Ys1rJN78URQ8JZRAlvA/edit?usp=sharing
Nowlan Freese Paige Kulzer Please review and let me know if any changes are required. I'd appreciate your feedback.