Skip to content

Commit e352546

Browse files
committed
Set up club and cohort 1
1 parent b2946d4 commit e352546

File tree

114 files changed

+5187
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+5187
-1
lines changed

.Rbuildignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
^.*\.Rproj$
2+
^\.Rproj\.user$
3+
^\.github$
4+
^[.]?air[.]toml$
5+
^\.vscode$

.github/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.html

.github/workflows/build_site.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
on:
2+
push:
3+
branches: main
4+
paths-ignore:
5+
- 'README.md'
6+
workflow_dispatch:
7+
8+
name: Render and deploy site
9+
10+
jobs:
11+
render:
12+
if: startsWith(github.repository, 'r4ds/')
13+
runs-on: ubuntu-latest
14+
permissions:
15+
contents: write
16+
steps:
17+
- name: Check out repository
18+
uses: actions/checkout@v4
19+
20+
- name: Set up Quarto
21+
uses: quarto-dev/quarto-actions/setup@v2
22+
23+
- name: Set up R
24+
uses: r-lib/actions/setup-r@v2
25+
with:
26+
use-public-rspm: true
27+
28+
- name: Set up DESCRIPTION dependencies
29+
uses: r-lib/actions/setup-r-dependencies@v2
30+
31+
- name: Render & Publish
32+
uses: quarto-dev/quarto-actions/publish@v2
33+
with:
34+
target: gh-pages
35+
env:
36+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr_check.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
on:
2+
pull_request:
3+
branches: main
4+
paths-ignore:
5+
- 'README.md'
6+
7+
jobs:
8+
render_site:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Check out repository
12+
uses: actions/checkout@v4
13+
14+
- name: Set up Quarto
15+
uses: quarto-dev/quarto-actions/setup@v2
16+
17+
- name: Set up R
18+
uses: r-lib/actions/setup-r@v2
19+
with:
20+
use-public-rspm: true
21+
22+
- name: Set up DESCRIPTION dependencies
23+
uses: r-lib/actions/setup-r-dependencies@v2
24+
25+
- name: Render
26+
uses: quarto-dev/quarto-actions/render@v2
27+
with:
28+
to: html
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
on:
2+
pull_request:
3+
branches: main
4+
paths:
5+
- 'README.md'
6+
workflow_dispatch:
7+
8+
jobs:
9+
render_site:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- run: 'echo "No build required" '

.gitignore

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.Rproj.user
2+
.Rhistory
3+
.Rdata
4+
.httr-oauth
5+
.DS_Store
6+
7+
# Ignore things generated during render.
8+
*.html
9+
*.rmarkdown
10+
/.quarto/
11+
/_site/
12+
/site_libs/
13+
figure-revealjs
14+
/[0-9][0-9]*.qmd
15+
16+
**/*.quarto_ipynb

.vscode/tasks.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Preview Site",
6+
"type": "shell",
7+
"command": "quarto render",
8+
"group": {
9+
"kind": "build",
10+
"isDefault": true
11+
},
12+
"problemMatcher": []
13+
}
14+
]
15+
}

DESCRIPTION

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Type: Book
2+
Package: bookclub-duckdb
3+
Title: DuckDB in Action Book Club
4+
Version: 0.0.10
5+
Authors@R: c(
6+
person(
7+
"Data Science Learning Community",
8+
email = "[email protected]",
9+
role = c("aut", "cre", "cph")
10+
)
11+
)
12+
License: CC BY NC SA 4.0
13+
URL: https://DSLC.io/duckdb, https://github.com/r4ds/bookclub-duckdb
14+
Depends:
15+
R (>= 4.1.0)
16+
Imports:
17+
dplyr,
18+
fs,
19+
glue,
20+
purrr,
21+
readr,
22+
rmarkdown,
23+
yaml

LICENSE.md

Lines changed: 161 additions & 0 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
1-
# bookclub-duckdb
1+
# DSLC DuckDB in Action Book Club
2+
3+
Welcome to the DSLC DuckDB in Action Book Club!
4+
5+
We are working together to read [_DuckDB in Action_](https://motherduck.com/duckdb-book-brief/) by Mark Needham, Michael Hunger, and Michael Simons (Manning, copyright 2024, [9781633437258](https://www.manning.com/books/duckdb-in-action)). If you'd like to buy a physical copy of the book, please consider using [this affiliate link](https://amzn.to/3LM3Mh5) to support the Data Science Learning Community.
6+
7+
Join the [#book_club-duckdb](https://dslcio.slack.com/archives/C010GJ3VAE5) channel on the [DSLC Slack](https://dslc.io/join) to participate.
8+
As we read, we are producing [slides about the book](https://dslc.io/duckdb).
9+
10+
## Meeting Schedule
11+
12+
If you would like to present, please see the schedule sign-up sheet for your cohort (linked below, and pinned in the [#book_club-duckdb](https://dslcio.slack.com/archives/C010GJ3VAE5) channel on Slack).
13+
14+
- Cohort 1 (facilitator: @cory): [Wednesdays 3pm central](https://www.timeanddate.com/worldclock/converter.html?iso=20251203T210000&p1=24&p2=1440) | [schedule](https://docs.google.com/spreadsheets/d/1B9WV0Iiv6XYDX49qKWuLkfiCrM0YUkfiCYB6NZH4DkY/edit?usp=sharing) | [meeting videos](https://www.youtube.com/playlist?list=PL3x6DOfs2NGhilW62WvHqPGAvyp1NAUcj)
15+
16+
<hr>
17+
18+
19+
## How to Present
20+
21+
This repository is structured as a Quarto website.
22+
To present, follow these instructions:
23+
24+
Do these steps once in RStudio or Positron:
25+
26+
1. [Setup Git and GitHub to work with RStudio](https://github.com/r4ds/bookclub-setup) (click through for detailed, step-by-step instructions; I recommend checking this out even if you're pretty sure you're all set).
27+
2. `usethis::create_from_github("r4ds/bookclub-duckdb")` (cleanly creates your own copy of this repository).
28+
29+
Do these steps each time you present another chapter:
30+
31+
1. Open your project for this book.
32+
2. `usethis::pr_init("my-chapter")` (creates a branch for your work, to avoid confusion, making sure that you have the latest changes from other contributors; replace `my-chapter` with a descriptive name, ideally).
33+
3. `pak::pak()` (installs any packages used by the book that you don't already have installed).
34+
4. Edit the appropriate chapter file (in `slides/`). Use `#` (section) and `##` (slide) to indicate new slides. You do *not* need to update the `_quarto.yml` index; it automatically finds chapter slide files.
35+
5. If you use any R packages that are not already in the `DESCRIPTION`, add them. You can use `usethis::use_package("myCoolPackage")` to add them quickly!
36+
6. Preview your changes! ctrl-shift-k (or command-shift-k) will render the current slide + anything that you haven't rendered before in RStudio or Positron. Please do this to make sure it works before you push your changes up to the main repo! Note: When the site builds on your machine, you'll get some untracked files (`01.qmd` etc in the root directory) and directories (`_site` and `.quarto`). Ignore these files; they're generated during the render, and *should* automatically update when you re-render. If you're having trouble rendering, try deleting old copies of these files/directories on your local machine; sometimes quarto gets "stuck." You might also need to delete something in `_freeze` if things aren't updating properly on something you've edited.
37+
7. Commit your changes (through the command line, using Rstudio's Git tab, or using Positron's Source Control section). The exact message usually isn't important, but something like "Updates to chapter 2 slides" is enough.
38+
8. `usethis::pr_push()` (pushes the changes up to github, and opens a "pull request" (PR) to let us know your work is ready). Note: This will open GitHub in a browser window, so you might want to open a browser and login to GitHub.com before this runs.
39+
9. (If we request changes, make them)
40+
10. When your PR has been accepted ("merged"), `usethis::pr_finish()` to close out your branch and prepare your local repository for future work.
41+
11. Now that your local copy is up-to-date with the main repo, you need to update your remote fork. Run `gert::git_push("origin")` or click the `Push` button on the `Git` tab of Rstudio.
42+
43+
When your PR is checked into the main branch, the quarto site will rebuild, adding your slides to [this site](https://dslc.io/duckdb).

0 commit comments

Comments
 (0)