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

Add documentation for the GenArk and UCSC Rest

    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

            Activity

            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            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.

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - 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.
            Hide
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited

            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.

            Show
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited 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 .
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            Jaya Sravani Sirigineedi I'm not seeing the diagram in either of the linked files or their parent folders. Where should I look?

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - Jaya Sravani Sirigineedi I'm not seeing the diagram in either of the linked files or their parent folders. Where should I look?
            Hide
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited

            Paige Kulzer I have added the sequence diagram for figure ideas as we discussed.

            Show
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited Paige Kulzer I have added the sequence diagram for figure ideas as we discussed.
            Hide
            pkulzer Paige Kulzer (Inactive) added a comment -

            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!

            Show
            pkulzer Paige Kulzer (Inactive) added a comment - 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!
            Hide
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited

            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.

            Show
            jsirigin Jaya Sravani Sirigineedi (Inactive) added a comment - - edited 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.

              People

              • Assignee:
                jsirigin Jaya Sravani Sirigineedi (Inactive)
                Reporter:
                jsirigin Jaya Sravani Sirigineedi (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: