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

Add expanded git documentation to Canvas and Dev Guide

        Details

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

          Description

          Situation: We have expanded the git documentation with a focus on new Windows users.

          Task: Add the expanded documentation to the Canvas Course git module and the igb developers guide.

            Attachments

              Issue Links

              is blocked by

              Task - A task that needs to be done. IGBF-3432 Expand Git documentation for Windows users

              • Major - Major loss of function.
              • Closed

                Activity

                Descending order - Click to sort in ascending order
                nfreese Nowlan Freese made changes -
                Resolution Done [ 10000 ]
                Status Post-merge Testing In Progress [ 10003 ] Closed [ 6 ]
                nfreese Nowlan Freese made changes -
                Status Merged Needs Testing [ 10002 ] Post-merge Testing In Progress [ 10003 ]
                nfreese Nowlan Freese made changes -
                Status Reviewing Pull Request [ 10303 ] Merged Needs Testing [ 10002 ]
                nfreese Nowlan Freese made changes -
                Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
                nfreese Nowlan Freese made changes -
                Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
                nfreese Nowlan Freese made changes -
                Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
                nfreese Nowlan Freese made changes -
                Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
                nfreese Nowlan Freese made changes -
                Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
                Hide
                Permalink
                nfreese Nowlan Freese added a comment -

                I have added the additional instructions for modifying the editor for Git Bash.

                As there are no other requested edits, closing ticket.

                Show
                nfreese Nowlan Freese added a comment - I have added the additional instructions for modifying the editor for Git Bash. As there are no other requested edits, closing ticket.
                nfreese Nowlan Freese made changes -
                Status To-Do [ 10305 ] In Progress [ 3 ]
                nfreese Nowlan Freese made changes -
                Status Reviewing Pull Request [ 10303 ] To-Do [ 10305 ]
                nfreese Nowlan Freese made changes -
                Status Pull Request Submitted [ 10101 ] Reviewing Pull Request [ 10303 ]
                nfreese Nowlan Freese made changes -
                Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
                karthik Karthik Raveendran made changes -
                Assignee Nowlan Freese [ nfreese ]
                karthik Karthik Raveendran made changes -
                Status First Level Review in Progress [ 10301 ] Ready for Pull Request [ 10304 ]
                karthik Karthik Raveendran made changes -
                Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
                karthik Karthik Raveendran made changes -
                Status First Level Review in Progress [ 10301 ] Needs 1st Level Review [ 10005 ]
                karthik Karthik Raveendran made changes -
                Assignee Karthik Raveendran [ karthik ]
                Hide
                Permalink
                karthik Karthik Raveendran added a comment - - edited

                For rebasing or squashing, the editor for Git Bash can be changed to any editor of the user's preference:
                For instance to change the editor to notepad, vim or nano, use 

                git config --global core.editor "nano"
#or
git config --global core.editor "vim"
#or
git config --global core.editor "notepad"

# to verify the change, use
git config --global core.editor

                To change the editor to any other, add the .exe path,

                # Notepad++
git config --global core.editor "'C:\Program Files\Notepad++\notepad++.exe' -multiInst -notabbar -nosession -noPlugin"
#or Sublime Text 
git config --global core.editor "'C:\Program Files\Sublime Text\sublime_text.exe' -multiInst -notabbar -nosession -noPlugin"
                Show
                karthik Karthik Raveendran added a comment - - edited For rebasing or squashing, the editor for Git Bash can be changed to any editor of the user's preference: For instance to change the editor to notepad, vim or nano, use git config --global core.editor "nano" #or git config --global core.editor "vim" #or git config --global core.editor "notepad" # to verify the change, use git config --global core.editor To change the editor to any other, add the .exe path, # Notepad++ git config --global core.editor "'C:\Program Files\Notepad++\notepad++.exe' -multiInst -notabbar -nosession -noPlugin" #or Sublime Text git config --global core.editor "'C:\Program Files\Sublime Text\sublime_text.exe' -multiInst -notabbar -nosession -noPlugin"
                nfreese Nowlan Freese made changes -
                Status Needs 1st Level Review [ 10005 ] First Level Review in Progress [ 10301 ]
                nfreese Nowlan Freese made changes -
                Assignee Karthik Raveendran [ karthik ]
                nfreese Nowlan Freese made changes -
                Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
                nfreese Nowlan Freese made changes -
                Assignee Nowlan Freese [ nfreese ]
                Hide
                Permalink
                nfreese Nowlan Freese added a comment - - edited

                I have created two new sub-pages in the IGB Developer's Guide under Developing Integrated Genome Browser.

                • Git for Windows - this page includes information for downloading and installing Git onto a Windows machine.
                • Git cheat sheet - this page includes useful git commands that the IGB team frequently uses.

                I have also added a link to the Canvas Course pointing Windows users to the Git for Windows page.

                To test: Please read through the various pages mentioned above and make sure that the text is accurate and clear.

                Question for Windows users: Is there a way to specify a different editor after installing Git Bash?
                -> Can someone try changing the default editor on Windows following these instructions?

                Show
                nfreese Nowlan Freese added a comment - - edited I have created two new sub-pages in the IGB Developer's Guide under Developing Integrated Genome Browser . Git for Windows - this page includes information for downloading and installing Git onto a Windows machine. Git cheat sheet - this page includes useful git commands that the IGB team frequently uses. I have also added a link to the Canvas Course pointing Windows users to the Git for Windows page. To test: Please read through the various pages mentioned above and make sure that the text is accurate and clear. Question for Windows users: Is there a way to specify a different editor after installing Git Bash? -> Can someone try changing the default editor on Windows following these instructions ?
                nfreese Nowlan Freese made changes -
                Story Points 1 0.5
                nfreese Nowlan Freese made changes -
                Story Points 0.5 1
                nfreese Nowlan Freese made changes -
                Assignee Nowlan Freese [ nfreese ]
                nfreese Nowlan Freese made changes -
                Description Situation: We have expanded the git documentation with a focus on new Windows users.

                Task: Add the expanded documentation to the Canvas Course git module and the igb developers guide.                 		Situation: We have expanded the git documentation with a focus on new Windows users.

                Task: Add the expanded documentation to the [Canvas Course git module|https://canvas.instructure.com/courses/1164217/pages/learn-git?module_item_id=12709537] and the [igb developers guide|https://wiki.bioviz.org/confluence/display/igbdevelopers/Developing+Integrated+Genome+Browser].
                nfreese Nowlan Freese made changes -
                Status To-Do [ 10305 ] In Progress [ 3 ]
                nfreese Nowlan Freese made changes -
                Link This issue is blocked by IGBF-3432 [ IGBF-3432 ]
                nfreese Nowlan Freese made changes -
                Field Original Value New Value
                Epic Link IGBF-1531 [ 17617 ]
                nfreese Nowlan Freese created issue -

                  People

                  • Assignee:
                    nfreese Nowlan Freese
                    Reporter:
                    nfreese Nowlan Freese
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    2 Start watching this issue

                    Dates

                    • Created:
                      Updated:
                      Resolved: