The other thing that might be useful here is for them to actually practice uploading a file to the directory
Aaron spoke at one point about having a terminal / command line “ninja” workshop → this could be a place to prepare / incorporate some of that more advanced programming in the command line or at least point students to resources and hand them a “cheat sheet” of commands

• Need to double check and confirm instructions work for DataHub (some participants had issues with access errors when trying to push to remote)
• Some users did not have their global configs set up. We should include instructions or a link to do that like this
• Add some information about pull requests vs just merging code
• Add an example of resolving a merge conflict

We should maybe rename this workshop to "Shell and Git" or better, "Command line and git", as Bash is being replaced by zsh.

Ask students to write a shell script that does something useful for them. For instance, they can write a shell script that creates a directory called /pdfs under /Download directory, then find PDF files in /Download and, copy those files to Download/pdfs. This shell script creates a backup.

#!/bin/sh

mkdir /home/jae/Downloads/pdfs 

cd Download

cp *.pdf pdfs/ 

echo "Copied pdfs"

Need to add a step between steps 7 & 8 to cd back out of the challenge folder before removing it (e.g., cd ..)

• Make it explicit to add README when creating the repo
• Lots of authentication/access issues, may be useful to streamline this/make some more explicit instructions around setting up remote, adding git config, etc.

• Include some examples that show you can perform commands (e.g,. mv, cp, ls) from a higher level directories by adding in the relative path (e.g., ls solutions/)
• 'less' command is not available on DataHub, so some questions were asked about why it wasnt working. Might want to add a disclaimer or change this to something else
• We may also want to include echo commands as a form of writing to file

This does not seem to be something that is native to Windows unless pre-installed on some OS versions. I think it only works in Powershell. But this is something that should be clarified for Windows users and downloaded if it's part of the workshop in the materials for 02_bash.md.

IMHO, this first section starts the workshop on a confusing foot since it doesn't work in all environments/shells and I recommend removing or moving it.

First things first! Your prompt (where you will enter Bash commands) can be confusing. To change it to the file path of your working directory followed by a dollar sign, type or copy/paste the below code:

Type or copy/paste PS1="\w\$ " into your prompt and press Enter.

Then, type exec bash into your prompt and press Enter.

Now, you will have a record of your location as you move around your computer!

NOTE: to display only the current working directoy - not the path - use a capital letter W in step 1 above instead :)

Emma and I discussed that it seems like lots of the workshop materials are centered around Mac OS. Thus, the Mac-specific lingo is uninterpretable by Windows users, leading to some confusion and interrupting the flow of the workshop. Thus, we need to be more intentional about having a balance between both users.

@aculich mentioned 5/31/2023 workshop to add git branch discussion.

During break, make sure participants have / (or help them make) GitHub account

01_getting_started:

• Include instructions on which settings to check when setting up Git token
• We may want to stress in the workshop description on the website to the participants to do their best to go through the steps on 01_getting_started.md. This would reduce the amount of friction for getting participants set up with Git.

02_bash:

• Include some examples that show you can perform commands (e.g,. mv, cp, ls) from a higher level directories by adding in the relative path (e.g., ls solutions/)
• 'less' command is not available on DataHub, so some questions were asked about why it wasnt working. Might want to add a disclaimer or change this to something else
• We may also want to include echo commands as a form of writing to file

02_bash_challenge:

• Need to add a step between steps 7 & 8 to cd back out of the challenge folder before removing it (e.g., cd ..)

03_git:

• Need to double check and confirm instructions work for DataHub (some participants had issues with access errors when trying to push to remote)
• Some users did not have their global configs set up. We should include instructions or a link to do that like this
• Add some information about pull requests vs just merging code
• Add an example of resolving a merge conflict

03_git_challenge:

• Make it explicit to add README when creating the repo
• Lots of authentication/access issues, may be useful to streamline this/make some more explicit instructions around setting up remote, adding git config, etc.

need this command to git push for some reason
git push -u -f origin master

There is a typo in the bash challenges that refers to "wordpac" instead of "wordpad." The instructions may also be dated because it refers to a "format" button that doesn't seem to exist in newer versions of wordpad.

discuss the significance of escape sequences as well

There are two small scripts in this workshop, one for python and another for R. If we plan to use DataHub or Binder link functionality with this workshop, we may need to create separate links, one for each platform.

Cover what the following mean in bash
.
..
*
mv (dual use as 1. To move a file and 2. To rename files)

today's google doc:
https://docs.google.com/document/d/1uq2lCSk9PEvu02mwXvZF8vEXaTkX4UkejQ4yXoLJAV4/edit#

It will be great to include something on the command "add" because in git it does not have the exact same meaning as the English word, it actually means adding an operation. Like if we remove a file locally, and want to remove it from the "staging area" and remote repo, we still do "git add file"

Add the following to the bottom of the readme file

Contributors

• Evan Muzzall
• Aniket Kesari
• Aaron Culich
• Pratik Sachdeva

@aculich mentioned during workshop on 5/31 for Bash-Git workshop to add an arrow for "git clone" in the image.
The file is under: Bash-Git/lessons/03_git.md "local/remote" image

This workshop is particularly difficult to teach because it’s not interactive at all
Add powerpoint slides for the workflow of using git and walk people through that
Building on some of the materials already there but making them more visually appealing and intuitive

• Under Collaborative Workflow, we might want to add an explicit point about checking existing branches using git branch?
• Figure under Collaborative Workflow makes it seem as if branches need to sync up with main through time
• We also might want to add a point at the end on removing local git repos (just deleting the folder) or github repo (settings, danger area)

This diagram could better explain the process starting from the initial git clone (and implicit checkout of the main branch):

I received confused questions about why the git checkout was part of this diagram in regards to committing and pushing to github, in particular because the diagram does not match the explanatory context around it, as the following steps 1-8 don't mention it at all, and then when branching is mentioned in collaboration the diagram isn't referenced again.

Here's a crude update that we can think about how to refactor:

(Aniket to add screenshot in reply)

• Instruction materials need to be reordered to: bash - git hub token + account - git
  Introduction was excellent!
• Asking affiliations in the beginning and experience level with command line and git were good opening.
• I think guiding through the "Reactions" on Zoom set the expectation and it was very helpful.
• Getting volunteers for Windows actually worked really well.
• However, we do need written instructions for Windows users so that they feel included and be able to follow the workshop. For example, using Git Bash on Windows (instead of command prompt) is not very obvious from the written instruction.
• Pacing is very good. We finished Bash section around 2:30
• Emphasizing when Bash would be useful - why not just use folder system on the mac?
• Executing a script from the command line might be useful (something really simple like print "helloworld")
• Explanation of jargons on navigating directories using command line Going in/out, up/down was very helpful.
• I think you can give more time when you pose a question to the group
• We should also have bash cheatsheet added to this repository or include it in the git_cheatsheet
• Pacing for Git was very good, but there are a lot of jargons (inherent to git system)
• Write up really does not capture what Aaron did for the workshop and I wonder if that affects the workshop in the future.
• There is a general interest in advanced git workshop

It would be good to have notes for instructions for windows users.

There were some trouble shooting with windows users and asking windows user to share screen and troubleshoot worked well for the workshop

For Bash for windows users / linux users, following instructions on Mac would not work.

Another example, to make font size larger for the Git Bash: Windows: Right click on top bars > settings? > Font > change font size.

@aculich presented this workshop from 10am-1pm. Here are some feedback I have on the presentation:

Presentation style

• the presentation pace was great
• general immediate answering participants questions were great
• some jargons but generally explained for people to be more comfortable
• a participant discussed that maybe connecting to other languages from other workshops would be helpful (i.e., Python)
• perhaps using languages like thinking about this like a "folder" system would be helpful; I also have heard of relative paths as "parent" and "child"

Presentation material

• gentle onboarding for why use git/ getting a git account
• the flow of the presentation could include more polls to bring people in on what's their stages
• the flow of the presentation could be restructured to have concrete examples (and participants can do without hand-holding in the future)
• perhaps breaking the workshop to more focused -- either individual or collaborative (@AnushaPB discussed this +1)
• personal token wasn't explicitly needed
• adding in how to use stack overflow is helpful (which aaron did on the spot)
• adding in how to look at history or how version control works explicitly in action would be helpful
• one example could be: creating the file -> put it on git -> writing over the same file accidentally -> how to retrieve it back!?

We've received several requests for a "advanced version" of the Bash + Git workshop would be helpful as a next step after the introductory material.

If you have specific ideas or requests of what you'd like to see included, please feel free to add to the discussion here.

add git clone [email protected]:dlab-berkeley/BashGit.git

to 1. git clone examples

Differences between command line in mac and terminal in windows - need to be articulated more thoroughly

Introduce pull/push from and to main branch first, then discuss branch nuances, specifically

1. Creating a branch, and
2. Pushing to a specific branch via git push --set-upstream origin master instead of git push or git push -u origin master

(this is currently not in the workshop materials)

• Include instructions on which settings to check when setting up Git token
• We may want to stress in the workshop description on the website to the participants to do their best to go through the steps on 01_getting_started.md. This would reduce the amount of friction for getting participants set up with Git.

I'm part of team 3's effort to overhaul the datasets for the workshops, and from the Readme and the current content I'm not sure if one is needed here. Will this workshop require a dataset, and if so, what sort of data would be most useful? Thanks!

I think it would be cool if participants created their own repository and added/committed/pushed from it to get some hands on experience using the git commands within their own repo. That would also allow them to get familiar with the github website and walk away with a repository they have created and can look at.

git challenge markdown file is missing solutions. @Akesari12 will add a solution for challenge 1.