|
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