[IGBF-2428] Improve on-boarding materials for Windows developers - JIRA UNCC

Details

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

Story Points:
0.25
Epic Link:
Improve IGB for developers
Sprint:
Summer 1: 8 Jun - 19 Jun

Description

We recently got some feedback from Logan Weidenhammer on how we can make some of our on-boarding materials more clear.

See comments in: https://jira.transvar.org/browse/IGBF-2373

For this task, make the recommend improvements.

Note: For modifying editing the Canvas class content, enroll in the class and then let me (Loraine) know. I can then add the necessary edit permissions to your user id.

Attachments

Issue Links

relates to

IGBF-2373 Move transcript isoform App into a separate repository

Closed

Activity

Ascending order - Click to sort in descending order

Ann Loraine created issue - 11/Jun/20 2:58 PM

Ann Loraine made changes - 11/Jun/20 2:58 PM

Field	Original Value	New Value
Epic Link		IGBF-1765 [ 17855 ]

Ann Loraine made changes - 11/Jun/20 2:58 PM

Link

This issue relates to ~~IGBF-2373~~ [ ~~IGBF-2373~~ ]

Ann Loraine made changes - 11/Jun/20 2:58 PM

Rank

Ranked higher

Ann Loraine made changes - 11/Jun/20 2:58 PM

Summary

Improve on-boarding materials as per feedback from RW

Improve on-boarding materials using feedback from RW

Ann Loraine made changes - 11/Jun/20 2:58 PM

Summary

Improve on-boarding materials using feedback from RW

Improve on-boarding materials using feedback in ~~IGBF-2373~~

Ann Loraine made changes - 11/Jun/20 2:59 PM

Epic Link

IGBF-1765 [ 17855 ]

IGBF-1531 [ 17617 ]

Ann Loraine made changes - 19/Jun/20 8:59 PM

Sprint

Summer 1: 8 Jun - 19 Jun [ 96 ]

Summer 1: 8 Jun - 19 Jun, Summer 2: 22 Jun - 3 July [ 96, 97 ]

Ann Loraine made changes - 19/Jun/20 8:59 PM

Rank

Ranked higher

Ann Loraine made changes - 19/Jun/20 10:03 PM

Assignee

Rachel Weidenhammer [ rweidenh ]

Logan Weidenhammer (Inactive) made changes - 24/Jun/20 12:05 PM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Hide

Permalink

Logan Weidenhammer (Inactive) added a comment - 25/Jun/20 1:40 PM

Minor editing completed to improve clarity of instructions on Canvas site:

"Set up your local IGB development environment" https://canvas.instructure.com/courses/1164217/pages/set-up-your-local-igb-development-environment?module_item_id=12709533
Changes link on point 3 to send the user to Java Archive site.

"Understand IGB development workflow" https://canvas.instructure.com/courses/1164217/pages/understand-igb-development-workflow?module_item_id=12709540
Added text to the paragraphs:

When done, the developer pushes their commits changes to the topic branch to their fork, which should be configured to automatically build a branch-specific installers. This can be seen in a successful build in Bitbucket's "Pipelines" tab. (Instructions on for configuration are covered elsewhere.)

Once the installer is built (seen as a BranchName.exe file in the "Downloads" tab), the developer adds a link to their topic branch to the Jira issue as a Comment. They then move the issue into the next column - "Needs 1st Level Review" - and un-assigns the issue. This signals to everyone else that the issue is now ready for review, and anyone with time and expertise can pick it up.

"Set up your fork - Fork IGB, add Jira link, add ssh key" https://canvas.instructure.com/courses/1164217/pages/set-up-your-fork-fork-igb-add-jira-link-add-ssh-key?module_item_id=31871518
Added words to reflect location of the "create fork" plus sign in point 3.

Needs review to make sure content is accurate and formatting is ok.

Show

Logan Weidenhammer (Inactive) added a comment - 25/Jun/20 1:40 PM Minor editing completed to improve clarity of instructions on Canvas site: "Set up your local IGB development environment" https://canvas.instructure.com/courses/1164217/pages/set-up-your-local-igb-development-environment?module_item_id=12709533 Changes link on point 3 to send the user to Java Archive site. "Understand IGB development workflow" https://canvas.instructure.com/courses/1164217/pages/understand-igb-development-workflow?module_item_id=12709540 Added text to the paragraphs: When done, the developer pushes their commits changes to the topic branch to their fork, which should be configured to automatically build a branch-specific installers. This can be seen in a successful build in Bitbucket's "Pipelines" tab. (Instructions on for configuration are covered elsewhere.) Once the installer is built (seen as a BranchName.exe file in the "Downloads" tab) , the developer adds a link to their topic branch to the Jira issue as a Comment. They then move the issue into the next column - "Needs 1st Level Review" - and un-assigns the issue. This signals to everyone else that the issue is now ready for review, and anyone with time and expertise can pick it up. "Set up your fork - Fork IGB, add Jira link, add ssh key" https://canvas.instructure.com/courses/1164217/pages/set-up-your-fork-fork-igb-add-jira-link-add-ssh-key?module_item_id=31871518 Added words to reflect location of the "create fork" plus sign in point 3. Needs review to make sure content is accurate and formatting is ok.

Logan Weidenhammer (Inactive) made changes - 25/Jun/20 1:41 PM

Status

In Progress [ 3 ]

Needs 1st Level Review [ 10005 ]

Logan Weidenhammer (Inactive) made changes - 25/Jun/20 1:41 PM

Assignee

Rachel Weidenhammer [ rweidenh ]

Ann Loraine made changes - 26/Jun/20 12:19 AM

Status

Needs 1st Level Review [ 10005 ]

First Level Review in Progress [ 10301 ]

Ann Loraine made changes - 26/Jun/20 12:19 AM

Assignee

Ann Loraine [ aloraine ]

Hide

Permalink

Ann Loraine added a comment - 26/Jun/20 12:31 AM

A question about this page:

Set up your local IGB development environment -
https://canvas.instructure.com/courses/1164217/pages/set-up-your-local-igb-development-environment

Are the instructions "to build and run IGB from inside Netbeans" correct? I'm wondering if we need to fix those instruction as well.

Show

Ann Loraine added a comment - 26/Jun/20 12:31 AM A question about this page: Set up your local IGB development environment - https://canvas.instructure.com/courses/1164217/pages/set-up-your-local-igb-development-environment Are the instructions "to build and run IGB from inside Netbeans" correct? I'm wondering if we need to fix those instruction as well.

Ann Loraine made changes - 26/Jun/20 12:31 AM

Assignee

Ann Loraine [ aloraine ]

Rachel Weidenhammer [ rweidenh ]

Ann Loraine made changes - 26/Jun/20 12:31 AM

Status

First Level Review in Progress [ 10301 ]

To-Do [ 10305 ]

Logan Weidenhammer (Inactive) made changes - 29/Jun/20 10:45 AM

Status

To-Do [ 10305 ]

In Progress [ 3 ]

Hide

Permalink

Logan Weidenhammer (Inactive) added a comment - 29/Jun/20 12:19 PM

I agree that these instructions are missing steps and need clarification. For example I myself am not sure how exactly to run "one of the "run_igb" scripts in the top level of the project." in the third point.

I can elaborate on the current instructions for running IGB in netbeans once I get mine to run. Right now attempting to run the IGB Main (run me) project results in netbeans getting stuck on the
"INFO com.affymetrix.main.OSGiHandler - OSGi is started with org.apache.felix.framework version 5.2.0" process.

No amount of reverting changes, mvn clean installing, or clean and build combination has resolved this so far. I will have to come back and look at it.

Show

Logan Weidenhammer (Inactive) added a comment - 29/Jun/20 12:19 PM I agree that these instructions are missing steps and need clarification. For example I myself am not sure how exactly to run "one of the "run_igb" scripts in the top level of the project." in the third point. I can elaborate on the current instructions for running IGB in netbeans once I get mine to run. Right now attempting to run the IGB Main (run me) project results in netbeans getting stuck on the "INFO com.affymetrix.main.OSGiHandler - OSGi is started with org.apache.felix.framework version 5.2.0" process. No amount of reverting changes, mvn clean installing, or clean and build combination has resolved this so far. I will have to come back and look at it.

Logan Weidenhammer (Inactive) made changes - 29/Jun/20 12:20 PM

Status

In Progress [ 3 ]

To-Do [ 10305 ]

Ann Loraine made changes - 06/Jul/20 7:29 AM

Summary

Improve on-boarding materials using feedback in ~~IGBF-2373~~

Improve on-boarding materials for Windows developers

Ann Loraine made changes - 06/Jul/20 7:29 AM

Sprint

Summer 1: 8 Jun - 19 Jun, Summer 2: 22 Jun - 3 Jul [ 96, 97 ]

Summer 1: 8 Jun - 19 Jun [ 96 ]

Hide

Permalink

Logan Weidenhammer (Inactive) added a comment - 06/Jul/20 11:34 AM

Neither deleting the IGB cache bundles nor cleaning the program in netbeans resolve the issue.

Same as above comment, running the IGB Main (run me) project stops on the process: "com.affymetrix.main.OSGiHandler - OSGi is started with org.apache.felix.framework version 5.2.0" and never continues on to open IGB.

Show

Logan Weidenhammer (Inactive) added a comment - 06/Jul/20 11:34 AM Neither deleting the IGB cache bundles nor cleaning the program in netbeans resolve the issue. Same as above comment, running the IGB Main (run me) project stops on the process: "com.affymetrix.main.OSGiHandler - OSGi is started with org.apache.felix.framework version 5.2.0" and never continues on to open IGB.