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

Improve on-boarding materials for Windows developers

    Details

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

      Description

      We recently got some feedback from Rachel 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

            Activity

            Hide
            rweidenh Rachel Weidenhammer (Inactive) added a comment -

            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
            rweidenh Rachel Weidenhammer (Inactive) added a comment - 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.
            Hide
            aloraine Ann Loraine added a comment -

            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
            aloraine Ann Loraine added a comment - 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.
            Hide
            rweidenh Rachel Weidenhammer (Inactive) added a comment -

            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
            rweidenh Rachel Weidenhammer (Inactive) added a comment - 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.
            Hide
            rweidenh Rachel Weidenhammer (Inactive) added a comment -

            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
            rweidenh Rachel Weidenhammer (Inactive) added a comment - 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.

              People

              • Assignee:
                rweidenh Rachel Weidenhammer (Inactive)
                Reporter:
                aloraine Ann Loraine
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: