Skip to content

Commit 8a9f745

Browse files
authored
Vignettes (#1)
Major overhaul of notes, including expanded content and vignettes.
1 parent baa59fd commit 8a9f745

17 files changed

Lines changed: 308 additions & 51 deletions

docs/_quarto.yml

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,14 @@ book:
3838
#location: sidebar # navbar, sidebar
3939
#type: textbox # overlay, textbox
4040

41+
reader-mode: true
42+
4143
#cover-image: images/cover.png
4244
#favicon: images/favicon.ico
4345

4446
# https://quarto.org/docs/websites/website-navigation.html#side-navigation
45-
#sidebar:
46-
# logo: images/ospo-logo.png
47+
sidebar:
48+
logo: images/ospo-logo.png
4749

4850
#sidebar:
4951
# contents:
@@ -76,11 +78,11 @@ book:
7678

7779
#- "-------------"
7880

79-
- part: "Dev Tools Setup"
81+
- part: "Development Tools"
8082
chapters:
81-
- prereqs/github.qmd
82-
- prereqs/vs-code-text-editor.qmd
83-
- href: prereqs/git-client.qmd
83+
- dev-tools/github.qmd
84+
- dev-tools/vs-code-text-editor.qmd
85+
- href: dev-tools/git-client.qmd
8486
text: "GitHub Desktop"
8587

8688

@@ -99,13 +101,17 @@ book:
99101

100102

101103

104+
- "-------------"
105+
- about.qmd
102106
- "-------------"
103107

104108

105109
appendices:
106-
- href: notes/clis/brew.qmd
107-
text: "Homebrew (Mac OS)"
108-
- notes/clis/git.qmd
110+
- part: "Command-line Tools"
111+
chapters:
112+
- href: dev-tools/clis/brew.qmd
113+
text: "Homebrew (Mac OS)"
114+
- dev-tools/clis/git.qmd
109115

110116
# shows up at bottom of page
111117
#body-footer: "© Copyright 2024, Your Name Here"
@@ -119,14 +125,20 @@ book:
119125

120126
format:
121127
html:
128+
toc: true
129+
toc-depth: 6
130+
toc-expand: true # keep all levels visible
122131
# https://quarto.org/docs/output-formats/html-themes.html
123132
theme:
124133
light: default #flatly
125-
dark: darkly
134+
dark: solar # vapor # superhero # slate # solar #quartz # darkly
135+
#dark: [superhero, superhero-gw-dark-theme.scss]
126136
css: styles.css
127137
number-sections: false
128138
from: markdown+emoji # enable emojis
129139

130140

141+
142+
131143
#pdf:
132144
# documentclass: scrreprt

docs/about.qmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# About
2+
3+
## Sponsoring Organization
4+
5+
The [GW Open Source Program Office (OSPO)](http://ospo.gwu.edu/) supports the GW community in their use of open-source tools, helps researchers comply with Open Science policies, and trains users in open-source development. The OSPO aims to help foster a culture of open collaboration and knowledge-sharing, aligned with the research and education missions of the university.
6+
7+
## About the Author
8+
9+
[Michael Rossetti](https://michael-rossetti.org/) is a data scientist, software developer, and adjunct professor. He has worked as a polling data analyst for a winning US Presidential campaign, a data analytics director for a Silicon Valley startup, and a technology consultant for the US Government. As an adjunct professor, he has taught courses in data science, computer science, and software development at universities including New York University, Georgetown University, and the George Washington University.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ If these commands produce a version-looking output and a filepath-looking output
4242

4343
### Installation on Mac
4444

45-
Mac users can install Git from https://git-scm.com/downloads, or via [homebrew](/notes/clis/brew.md) (recommended) with `brew install git`.
45+
Mac users can install Git from <https://git-scm.com/downloads>, or via [homebrew](/notes/clis/brew.md) (recommended) with `brew install git`.
4646

4747
After installing, restart your terminal application, where you should now be able to execute Git commands (like `git --version`).
4848

4949
### Installation on Windows
5050

51-
Windows users can install Git from https://git-scm.com/downloads. This installation should also install a program called Git Bash, which Windows users can use as their default command-line computing application.
51+
Windows users can install Git from <https://git-scm.com/downloads>. This installation should also install a program called Git Bash, which Windows users can use as their default command-line computing application.
5252

5353
The Git Bash application is where you can execute Git commands (like `git --version`). Depending on how you installed it, your Command Prompt and Anaconda Prompt applications may also have access to the Git CLI, in which case you can run Git commands from within those applications as well.
5454

docs/dev-tools/git-client.qmd

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
# Git Clients
3+
4+
Git is the underlying version control system used by platforms like GitHub.
5+
6+
The goal of a Git client is to help us track changes in our code, and interface with code hosting platforms like GitHub.
7+
8+
Professionals may prefer to use [Git from the command line](./clis/git.qmd), but there is a learning curve. Instead, beginners are encouraged to get started with GitHub Desktop, which provides an easier to use graphical user interface (GUI).
9+
10+
## GitHub Desktop
11+
12+
### Installation and Configuration
13+
14+
First, install [GitHub Desktop software](https://desktop.github.com/), for Mac or Windows.
15+
16+
After installing, you are encouraged to configure certain settings. See this [GitHub Desktop setup guide](https://docs.github.com/en/desktop/installing-and-authenticating-to-github-desktop/setting-up-github-desktop) for more detailed instructions.
17+
18+
From the "Accounts" settings, you will need to login with your GitHub account credentials to associate your work with your GitHub profile, and to push and pull code to GitHub on your behalf.
19+
20+
![Logging in with your GitHub Account in GitHub Desktop.](../images/github-desktop-settings-accounts.png)
21+
22+
From the "Integrations" settings, choose your default text editor (e.g. VS Code). This will configure certain buttons and menu options in GitHub Desktop that will help you easily open your coding project in the text editor in the future.
23+
24+
![Configuring preferred tools in GitHub Desktop.](../images/github-desktop-settings-integrations.png)
25+
26+
27+
### Success Criteria
28+
29+
You should be able to open the GitHub Desktop application, and visit the settings to see you are logged in with your GitHub account.
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,6 @@ Afterwards, consider signing up for the [GitHub Student Developer Pack](https://
1111

1212
## Success Criteria
1313

14-
If successful, when you view this (or any) repository on GitHub, you should be able to click the buttons on the top-right of the page to "Star" this repository, and also optionally "Fork" it (i.e. create a copy under your own control).
14+
If successful, when you view a repository on GitHub, you should be able to click the buttons on the top-right of the page to "Star" the repository, and also "Fork" it (i.e. create a copy under your own control).
15+
16+
With a few clicks, you are getting started in the world of version control and open source software.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Text Editor
44

5-
We'll be using software called a **text editor** to create and edit files of code. Similar to word processing software like Microsoft Word, text editors allow us to write and save documents of text. But unlike word processors, which save extra metadata (e.g. styles and formatting) along with the underling text, text editors save files comprised of just text.
5+
We'll be using software called a **text editor** to create and edit files of code. Similar to word processing software like Microsoft Word, text editors allow us to write and save documents of text. But unlike word processors, which save extra metadata (e.g. styles and formatting) along with the underling text, text editors save files comprised of just the raw text.
66

77
There are many text editor options out there, and it seems each developer has their own preference. Regardless of which text editor you choose, you are highly encouraged to configure it with certain plugins, packages and extensions to enhance your experience and save you time.
88

docs/exercises/hello-version-control/index.qmd

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# "Hello, Version Control" Exercise
22

3+
## Motivation
4+
5+
:::{.callout-tip title="The World's Largest Jam Session"}
6+
Imagine walking into a park where musicians from all over the world are jamming together. Some are pros, others are just learning, but the melody is constantly evolving — new riffs, unexpected harmonies, shared rhythms.
7+
8+
That's open source software. It's a space where someone's starter code becomes someone else's masterpiece. Where ideas remix and evolve out in the open. Where the act of contributing, no matter how small, helps shape the music that powers the digital world.
9+
10+
You don't need to be a rockstar to join. Just pick up your instrument and start playing.
11+
:::
312

413
## Learning Objectives
514

125 KB
Loading
65.1 KB
Loading

0 commit comments

Comments
 (0)