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

            Activity

            Hide
            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 ?
            Hide
            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"
            Hide
            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.

              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: