Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all the Markdown files for the S24 running of this lab #129

Merged
merged 10 commits into from
Jan 16, 2024

Conversation

NicMcPhee
Copy link
Member

@NicMcPhee NicMcPhee commented Jan 16, 2024

There's a lot here, so this is going to be a kind of annoying PR to review. The highlights:

  • @kklamberty and I decided that since we now have all these automatic checks in places, the badges aren't really necessary since the green check or red x tells us what we want/need to know. Including and updating the badges does add a little friction, so we'll just remove them.
  • I added a lot of detail about how to create a Personal Access Token specifically for this lab so that students can do the command line git work described in part one.
  • I removed the historical notes about the change to main as I think that transition is mostly done now and people are a lot less likely to run into the old approach.
  • Added a note about the need to add GitKraken to the organization in the facutly/TA todos. I never remember to do this and get burned at the start of the semester, so I thought it would be good to mention it.
  • I attempted to document the new merge queue approach. This is probably the part I'm least confident about, and I may not really know what it looks like until we do it tomorrow in lab.

There were also a bunch of minor grammar fixes, updates, etc. I even found one dangling reference to IntelliJ IDEA, which I switched to VS Code. 😜

Closes #118

@kklamberty and I decided that since we now have all these automatic checks in places, the badges aren't really necessary since the green check or red x tells us what we want/need to know. Including and updating the badges does add a little friction, so we'll just remove them.

The other changes were fixing an out-of-date link and a grammar mistake.
There are quite a lot of changes here, where I wrote up the stuff about Personal Access Tokens (PATs). I hope I got all this right; it seemed to work when I ran through it on my own.

I also added several screenshots and made various minor edits.
It looks like pretty much everyone has moved to using `main`, so I don't think we need this historical note anymore.
I found I couldn't push from GitKraken on the new organization, and it was because GitKraken hadn't been given permissions on that organization yet. I added that to the faculty/TA setup checklist.
This attempts to document the new merge queue approach in GitHub. I hope this makes things go more smoothly in class tomorrow!

I also changed some of the notes to use the new-ish `git switch` command, which I find a lot more intuitive than `git checkout`.

I added several screen grabs that will hopefully make things easier to follow.
A variety of mostly minor changes, updates, and corrections to the the Markdown files in the `docs` folder.
@NicMcPhee NicMcPhee self-assigned this Jan 16, 2024
@NicMcPhee NicMcPhee added enhancement documentation Issues related to write-ups and documentation labels Jan 16, 2024
Copy link
Member

@kklamberty kklamberty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny typos; otherwise looks great!

PART_1_SHARE_INFO.md Outdated Show resolved Hide resolved
PART_2_JAVA_INTRODUCTIONS.md Outdated Show resolved Hide resolved
Thanks to @kklamberty for the really careful read through!
@NicMcPhee
Copy link
Member Author

Thanks for the careful read through. Both of those are now fixed!

@NicMcPhee NicMcPhee added this pull request to the merge queue Jan 16, 2024
@NicMcPhee NicMcPhee removed this pull request from the merge queue due to a manual request Jan 16, 2024
@NicMcPhee NicMcPhee added this pull request to the merge queue Jan 16, 2024
@NicMcPhee NicMcPhee removed this pull request from the merge queue due to a manual request Jan 16, 2024
@NicMcPhee NicMcPhee added this pull request to the merge queue Jan 16, 2024
@NicMcPhee NicMcPhee removed this pull request from the merge queue due to a manual request Jan 16, 2024
@NicMcPhee NicMcPhee added this pull request to the merge queue Jan 16, 2024
auto-merge was automatically disabled January 16, 2024 05:24

Merge queue setting changed

@NicMcPhee NicMcPhee removed this pull request from the merge queue due to the queue being cleared Jan 16, 2024
@NicMcPhee NicMcPhee merged commit 0531510 into main Jan 16, 2024
5 checks passed
@NicMcPhee NicMcPhee deleted the update-write-ups-s24 branch January 16, 2024 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to write-ups and documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write up something about merge queues
2 participants