Skip to content

Commit

Permalink
docs(preamble): 📝 move auto-save section into precourse tasks (#187)
Browse files Browse the repository at this point in the history
## Description

It didn't make any sense that the auto-save section was during the
session, it makes more sense in the pre-course tasks. So moved it.

Closes #158

## Checklist

- [x] Ran spell-check
- [x] Formatted Markdown
- [x] Rendered website locally
  • Loading branch information
lwjohnst86 authored Oct 4, 2024
1 parent 0088462 commit 1984d4b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
23 changes: 19 additions & 4 deletions preamble/pre-course.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,13 @@ about them are found as you work through this section.
10. Run a check using `r3::check_project_setup_advanced()` to see that
everything is as expected. You'll later need to paste this output
into the survey.
11. Read about the basic course details in @sec-course-details.
12. Read the syllabus in @sec-syllabus.
13. Read the [Code of
11. Set up some quality of life options in RStudio in
1.
12. Read about the basic course details in @sec-course-details.
13. Read the syllabus in @sec-syllabus.
14. Read the [Code of
Conduct](https://guides.rostools.org/conduct.html).
14. **Complete the pre-course
15. **Complete the pre-course
[survey](https://docs.google.com/forms/d/e/1FAIpQLSfzTLrLFyQHj79YGaCQDN5fUZ_9et1qdmtDGiq6gNPGzFSCyQ/viewform?usp=sf_link)**.
This survey is pretty quick, maybe \~10 minutes.

Expand Down Expand Up @@ -403,6 +405,19 @@ doesn't, start over by deleting everything in the `data-raw/` folder
again. If your output looks a bit like the above, than copy and paste
the output into the survey question at the end.

## Set up some quality of life options {#sec-quality-of-life}

Some of the most common "issues" we encounter in the course when it
comes to Git are caused by files not being saved so the changes can't be
seen by Git. To help with this, we suggest turning on some options in
RStudio. While, there are many options inside the Global Options in
RStudio that can help you work better and faster, the two we want you to
to use will help you and us out during the course:

- Go into `Tools -> Global Options -> Code -> Saving`.
- Under the heading "General", tick on all of those check boxes.
- Under the heading "Auto-save", tick on both those check boxes.

## Course introduction {#sec-course-details}

Most of the course description is found in the syllabus (@sec-syllabus).
Expand Down
12 changes: 0 additions & 12 deletions sessions/smoother-collaboration.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -582,18 +582,6 @@ Since this mode is on automatically in the `doc/learning.qmd` file, as
we work through the sessions, we'll get lots of experience using it.
We'll also eventually switch so that the whole project uses this mode.

## Exercise: A few small changes to improve your workflow

> Time: \~2 minutes.
There are many options inside the Global Options in RStudio that can
help you work better and faster. There are a few that will help a lot,
especially in this course and with the workflows we are showing:

- Go into `Tools -> Global Options -> Code -> Saving`.
- Under the heading "General", tick on all of those check boxes.
- Under the heading "Auto-save", tick on both those check boxes.

## Exercise: Update the README file, while using canonical markdown mode

> Time: \~10 minutes.
Expand Down

0 comments on commit 1984d4b

Please sign in to comment.