Skip to content

Commit

Permalink
lots of details following posit cohort feedback & getting ready for css
Browse files Browse the repository at this point in the history
  • Loading branch information
jules32 committed Sep 15, 2023
1 parent 58b39ea commit dff0fd9
Show file tree
Hide file tree
Showing 13 changed files with 300 additions and 121 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,38 @@ https://posit.co/blog/keynotes-and-talks-at-posit-conf-2023/
### Documenting things: openly for future us

RMarkdown and Quarto are shifting the paradigm for how professionals learn to code, write documentation, and teach others. I'll showcase the style I first experienced by Jenny Bryan (Stat545, Happy Git With R, What They Forgot): narrative and code together, shared openly as a website, that builds trust with learners and provides a resource to consult during and outside of live-teaching. This mode shifts culture in a powerful way, since we can fork this idea, repeat it in our own work. I’ll share examples of how professional researchers are using this style to write open documentation, from technical workflows to community onboarding. I’ll also highlight design elements for writing open documentation, and tips for doing so with Quarto.


## Feedback - takeaways

Documentation opens up spaces and makes people feel welcome and part of the team

that documentation is hard, but its's worth it; it can be used to training and orient people to meet them where they are at

## To discuss with Sam: CSS

- backgrounds: visually distinguish sections
- intro, lightning
- what's possible (repeated)
- story: nasa cookbook
- story: nasa 3 years
- story: noaa+
- closing (same as intro?)

- fonts: to visually distingish
- 3 lightning headers from their subsections
- can we make footer text smaller (like `ref-text`?)


## TO discuss with Stef: story

- closing slide
- NASA place & space

## Tips for next 5 days

Practice out loud as much as possible

With a clicker - muscle memory.

When we walk on stage, we are on your time. Wiggle your toes, take a deep breath, start when you're ready. Don't rush. Enjoy it.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/amy-steiker-cloud-clinic-teaching.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/anchor-gdoc-bookmark-annotated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/anchor-quarto-annotated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cookbook-onboarding-annotated.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/cookbook-onboarding.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/happy-git-with-r.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/modular-r-for-excel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/tools-jupyterhub.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
197 changes: 137 additions & 60 deletions index.html

Large diffs are not rendered by default.

Loading

0 comments on commit dff0fd9

Please sign in to comment.