Improve On-Boarding Materials

Resources for onboarding
https://canvas.instructure.com/courses/1164217/modules
https://wiki.transvar.org/display/igbdevelopers/Developing+Integrated+Genome+Browser#DevelopingIntegratedGenomeBrowser-Startwork-makeabranch
https://www.youtube.com/watch?v=LjPNT1k9cqk

Start with IGBF-2539 On-Boarding: Step 0

[~aloraine],
Below is the proposed new description for On-Boarding: Step 0 including feedback from Irvin. Please view it at the link to see it in the proper formatting https://docs.google.com/document/d/1XXOo2Qf_eIOeHFdPbGtF6FaQQJdy7AewqkCq5jX9ppI/edit?usp=sharing

Let me know if there is any content you would like to see changed.

Proposed new description for Step 0

Welcome to your first on-boarding task for the IGB core development team!
We are super excited you have joined us! We hope you will enjoy your time with us and will make big contributions to the code base and the IGB community.

For the next steps, please do the following:
Go to https://canvas.instructure.com and make a free account.
(NOTE Need a join code, or the student/enrollee needs to create an account directly from inside the course
Log in and enroll in https://canvas.instructure.com/courses/1164217)
In Module I of the course, read: IGB Background and Intro to IGB Data Visualization
“Click on ‘Modules’ on the left side and read the two introduction pages: ‘IGB Background’ and ‘Intro to IGB Data Visualization’.”
Download and install the current release of IGB onto your computer.
To do this go to https://www.bioviz.org/
Click the “install IGB” button in the top right
The appropriate version for your operating system should be supplied for you
If you need a different version, click the “Click here for other ways to download IGB” hyperlink to see downloadable versions of IGB for other operating systems.
Click the button to download IGB for your computer
Run the downloaded file
Follow the instructions in the setup wizard.
Open and run the Integrated Genome Browser software.
The IGB Quickstart webpage will open automatically in your web browser.
IGB may take several seconds to launch.
Using IGB, follow along and copy the actions shown in this video: https://www.youtube.com/watch?v=LjPNT1k9cqk
Re-create the scene shown at the very end of the video
Then use the camera icon button in the IGB toolbar at the top, or go to File > Save Image to take a picture of IGB showing the scene at the end of the video;
upload that image here as an attachment (you can use the plus icon to the right of “Attachments”).
Move the ticket to “Needs 1st Level Review” by clicking the “Workflow” dropdown button at the top (under the ticket name), and select “Request Review”. You could also drag the ticket over to the right one space from the Agile board > IGB > Work view.
Since this might be the first ticket you do, and it needs to be completed before you move on to On-Boarding: Step 1 (Step 0 is a blocker for Step 1), reach out to another developer here to review your ticket with you before you move on.

Reviewers:
Watch the quickstart video https://www.youtube.com/watch?v=LjPNT1k9cqk
Confirm that the assignee has uploaded an image with graphs loaded and configured to the same scale as each other, as shown in the video
Confirm that the assignee has enrolled in the class. To do this select the “People” tab and look for the student’s name in the list

Logan Weidenhammer - Please go ahead and incorporate suggested changes into https://jira.transvar.org/browse/IGBF-2539 if they are not already there.

[~aloraine],

Changes are complete on On Boarding Step 0

For On Boarding Step 1 IGBF-1763
How would a new developer know that their "Jira user groups and Project Roles" in their JIRA profile are correct? What information should they see exactly?

I think you can answer the last question yourself. Look thru Jira and also use web searches to find out.

attn: Logan Weidenhammer

[~aloraine],

I could be mistaken, it looks like viewing project roles might be a feature limited to the project owner or administrators.

I am trying to give the new developer a way to double check that their JIRA profile has been assigned to all of the correct groups and separately project roles. Currently the instructions say to "check" them, but not for what exactly.

For example I can see my groups :
confluence-users
jira-developers
jira-testers
jira-users
loraine lab

But at this time I think would have to ask a senior member of the development team to also look at these groups to make sure none are missing.

So I think my question is: should I list these groups as ones the new developer should look for on their profile, or should I instruct them to come seek out a senior dev to check the groups with them?

Ok thanks for the clarification!

Let's tell the new developer which groups they should be a part of it, and ask them to check that they were added to these groups.

The reviewer can check that the new user was added properly by trying to use the "at" feature when writing or editing a comment in Jira. When you type the "@" character, a list of potential users opens. The reviewer should check that the new developer's user name is now one of the options.

FYI:

Sometimes this can get a little confusing! In the US, kids learn to say "at" for @. In India, kids learn to call it "add-the-rate".

[~aloraine], Ok I will add your feedback to the instructions. And thank you for the "@" information!

Final draft for On Boarding: Step 1 instruction is now ready for approval.
It can be seen here https://docs.google.com/document/d/1XXOo2Qf_eIOeHFdPbGtF6FaQQJdy7AewqkCq5jX9ppI/edit?usp=sharing

The added parts are:
Next, check to make sure you are added to the Jira user groups and Project Roles. To do that, view your user profile. Log into Jira and visit this link: https://jira.transvar.org/secure/ViewProfile.jspa?name=USERNAME, substituting your user name. You can also reach your profile page by clicking on the gravatar image representing yourself.
The groups should be as follows: confluence-users, jira-developers, jira-testers, jira-users, and loraine lab.

(and)

[Reviewers] check that the new user was added properly by trying to use the "@" feature when writing or editing a comment in Jira. if the new user is properly added to the group, they should now be one of the suggested options for the “@” feature.

On the same document, On Boarding: Step 2 draft improvement is complete. Minor suggested edits regarding what makes a private repository, and how to run the branch pipeline to create IGB installers.

I don't see any changes needing to be made to On Boarding: Step 3's description itself. There have been some suggestions for adding content to the canvas course covering concepts in the git branching tutorial.

On Boarding 4 is complete pending any changes needed per the comment I left there.

On Boarding 5 looks satisfactory at this time; I will likely be diving into that in the future and will make any changes then.

Moving to done.