Skip to content

Commit

Permalink
notes and ac
Browse files Browse the repository at this point in the history
  • Loading branch information
brownsarahm committed Sep 11, 2024
1 parent 824ce01 commit ac4397c
Show file tree
Hide file tree
Showing 6 changed files with 271 additions and 1 deletion.
7 changes: 7 additions & 0 deletions _practice/2024-09-10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
*the text in `()` below is *why* each step is assigned*

1. review today's notes after they are posted, both rendered and the raw markdown versions. Include links to both views in your badge PR comment. (to review)
1. read Chapter 1, "Decoding your confusion while coding" in [The Programmer's Brain](https://www.manning.com/books/the-programmers-brain#toc) add a file called {index}`brain.md` to your kwl repo that summarizes your thoughts on the chapter. Do you think this information will help you approach learning more effectively? why or why not? How, if at all, does it changes how you think about debugging and learning to program? Give examples of how you have encountered the different types of confusion in your prior programming experiences. (to help you get good strategies and prime for things we will see in the next few weeks)
2. ["Watch"](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) the [course website repo](https://github.com/compsys-progtools/fall2024), specifically watch Releases under custom (to get notifications)
3. map out your computing knowledge and add it to your kwl chart repo in a file called {index}`prior-knowledge-map.md`. Use [mermaid](https://mermaid-js.github.io/mermaid/#/) syntax, to draw your map. GitHub can render it for you including while you work using the preview button. (what we will learn will connect a lot of ideas, mapping out where you start, sets you up for success)
4. Read more about [version control in general](https://www.atlassian.com/git/tutorials/what-is-version-control) and add a "version control" row to your KWL chart with all 3 columns filled in. (git is version control, but not the only one)
2 changes: 2 additions & 0 deletions _prepare/2024-09-12.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
1. Choose where you want to save files for this class locally on your computer and make note of that location. (nothing to submit; but we will be working locally and you need to have a place)
1. Think about how you think about files and folders in a computer. What do you know about how they are organized? how they're implemented? (nothing to submit)
5 changes: 5 additions & 0 deletions _review/2024-09-10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*the text in `()` below is *why* each step is assigned*

1. review today's notes after they are posted, both rendered and the raw markdown versions. Include links to both views in your badge PR comment. (to review)
2. ["Watch"](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) the [course website repo](https://github.com/compsys-progtools/fall2024), specifically watch Releases under custom (to get notifications)
3. map out your computing knowledge and add it to your kwl chart repo. this can be an image that you upload or a text-based outline in a file called {index}`prior-knowledge-map`. (optional) try mapping out using [mermaid](https://mermaid-js.github.io/mermaid/#/) syntax, we'll be using other tools that will faciltate rendering later (what we will learn will connect a lot of ideas, mapping out where you start, sets you up for success)
1 change: 1 addition & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ parts:
chapters:
# - glob: notes/2023-*.md
- file: notes/2024-09-05.md
- file: notes/2024-09-10.md
- caption: Activities
chapters:
- file: activities/kwl
Expand Down
70 changes: 69 additions & 1 deletion notes/2024-09-05.md
Original file line number Diff line number Diff line change
Expand Up @@ -300,4 +300,72 @@ For screenshots, see the [Manually running a workflow, on GitHub](https://docs.g
```{include} ../_practice/2024-09-05.md
```
````
`````
`````

## We havea Glossary!!

For example, the term we used above:

[repository](https://compsys-progtools.github.io/spring2024/resources/glossary.html#term-repository)

```{tip}
In class, on prismia, I will sometimes link like above, but you can also keep the page open if that is helpful for you.
```


In the course site, glossary terms will be linked as in the follwing list.

Key terms for the first class:
- {term}`repository`
- {term}`git`
- {term}`github`
- {term}`PR`


## Questions after class


### How do I actually use Git/Github with one of my coding projects?

We will build that up


### What conceptually are we supposed to take from today lesson aside from just how pull requests work?

the key vocabulary.

### What kind of projects will we be completing?

Optionally, you may complete projects. You can see examples in the build section.

### Will this class go over topics that will help me on CSC 212 content?

the collaboration on github will help

### what a day to day looks like in this class

a lot like this class, but the 3rd class will be more typical than the first 2.

### will we need to access git without using github

we will use the git program without GitHub yes, locally on your computer

### how to create branches and merge branches to the main. Other basic features of github

We will learn over time

### I want to learn all of github's functions.

We will not get to *every* function, but we will cover the main categories

### Something that I want to learn more about is using git from the command line

Soon!

### Nothing specific, I would just like to learn more about GitHub in general because I know how important of a tool it is

perfect! that is what we will do

### just how to utilize github more and all the futures we haven't covered

we will get there
187 changes: 187 additions & 0 deletions notes/2024-09-10.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@

+++{"lesson_part": "main"}
# More orientation

Today we will:
- continue getting familiar with the structure of GitHub
- clarify more how the course will flow
- practice with new vocabulary

*Last class was a lot of new information, today we will reinforce that mostly, and add only a little*

## Warm up

1. Navigate to your KWL repo
2. Find the issues tab
3. Open the prepare-2024-09-10 issue and discuss the questions with your classmates at your table

*hint: my KWL repo URL is: `https://github.com/compsys-progtools/fall24-brownsarahm`

Becoming an expert requires:
- different types of study
- pracitce and feedback to get better



## Making up for action issue last week

To activate the workflows in your repo, edit them, even adding a space or deleting a blank line will make it work.

````{margin}
```{note}
[where I found this workaround](https://github.com/orgs/community/discussions/127455#discussioncomment-9741103)
```
````

We fixed the `forgottenexperience.yml` file and then [ran it manually](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow).

Then we edited the file it created to add a title on the line with one `#` (should be line 10) uisn ghte 3 dots menue in the top right of the file on the `files changed` tab of the PR.


```{note}
When you add more commits to a branch that has a PR, it automatically updates the PR.
```


note, here we are learning *by example* and then *synthesizing* that into more concrete facts.

+++{"lesson_part": "main"}

"just play with it"

- common attitude in CS
- not optimal for learning
+++{"lesson_part": "main"}
**my goal is to teach you to get better at learning in that way, bc it is what employers will expect**

To do this:
- set up opportunities for you to *do* the things that give you the opportunity
- highlight important facts about what just happened
- ask you questions to examine what just happened
+++{"lesson_part": "main"}

This is why attendance/participation is a big part of your grade.

Experience badges are evidence of having learned.


+++{"lesson_part": "main"}

### My focus is for you to learn


- that means, practice, feedback, and reflection
- you should know that you have learned
- you should be able to apply this material in other courses

+++{"lesson_part": "main"}

### Learning comes in many forms

- different types of material are best remembered in different ways
- some things are hard to explain, but watching it is very concrete

+++{"lesson_part": "main"}

## Learning is the goal

- producing outputs as fast as possible is not learning
- in a job, you may get paid to do things fast
- your work also needs to be correct, without someone telling you it is
- in a job you are trusted to know your work is correct, your boss does not check your work or grade you
- to get a job, you have to interview, which means explaining, in words, to another person how to do something


+++{"lesson_part": "main"}

## What about AI?

Large Language Models will change what programming looks like, but understanding is always going to be more effective than asking an AI. Large language models actually do not know anything, they just know what languages loook like and generate text.


*if you cannot tell it when it's wrong, you do not add value for a company, so why would they pay you?*

+++{"lesson_part": "main"}

## This is a college course

- more than getting you one job, a bootcamp gets you one job
- build a long (or maybe short, but fruitful) career
- build critical thinking skill that makes you adaptable
- have options

+++{"lesson_part": "main"}
## How does this work?

### In class:

1. Memory/ understanding checks
1. Review/ clarification as needed
1. New topic demo with follow along, tiny practice
1. Review, submit questions


### Outside of class:


1. Read notes to refresh the material, check your understanding, and find more details
1. Practice material that has been taught
1. Activate your memory of related things to what we will cover to prepare
1. Read articles/ watch videos to either fill in gaps or learn more details
1. Bring questions to class

+++{"lesson_part": "main"}

I give a [time breakdown](https://compsys-progtools.github.io/spring2024/syllabus/schedule.html#recommended-workload-distribution) in the syllabus.


## Prepare for next class

```{include} ../_prepare/2024-09-12.md
```

## Badges

`````{tab-set}
````{tab-item} Review
```{include} ../_review/2024-09-10.md
```
````
````{tab-item} Practice
```{include} ../_practice/2024-09-10.md
```
````
`````

## Questions After Class

### How can I create my own actions to run that will create issues and pull requests?

We will learn this a bit later, but you can read ahead in the [docs](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions).

### What is the purpose of the wiki within GitHub?

To serve as documentation, wiki-style for the repo. It was more common before github added pages. A lot of open source projects now host documentation using github pages. We will learn how this works later, but this website uses pages.

### Do we merge the pull request for the experience report into main?

Only when approved (but if you forget, @ me and I can fix it)

### Just still how to better navigate github because while I understood most of it was still confusing at points

We will be doing all of these things over and over, so you will get them, it's okay!

### Is it possible to rename a committed change?

You can change a commit message, yes!

### How do we access the old file after we already commit changes?

On GitHub.com, you go to the commits on the repo (click the {fa}`fa-clock-rotate-left` icon or add `/commits` to the repo's URL) and then choose view at that point.

### How can we edit our github using the terminal?

Next class!

0 comments on commit ac4397c

Please sign in to comment.