Initial commit

.github/workflows/quarto-publish.yml

@@ -0,0 +1,30 @@
+on:
+  push:
+    branches: main
+
+name: Render and Publish
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2 
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          # To install LaTeX to build PDF book 
+          tinytex: true 
+          # uncomment below and fill to pin a version
+          # version: 0.9.600
+
+      # add software dependencies here
+
+      - name: Publish to GitHub Pages (and render)
+        uses: quarto-dev/quarto-actions/publish@v2
+        with:
+          target: gh-pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions
+

.gitignore

@@ -0,0 +1,13 @@
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
+
+/.quarto/
+*_cache/
+_site/
+
+.DS_Store
+
+# Ignore notebook checkpoint files
+.ipynb_checkpoints

README.md

@@ -0,0 +1,15 @@
+# Quarto + GitHub Contributing Clinic
+
+A book that is a 1.5-hr session to teach folks how to contribute to existing Quarto sites & books on GitHub. Analogous to our [GitHub Clinic](https://openscapes.github.io/series/core-lessons/github/) with 2x short lessons and activities.
+
+[POP](https://suzannehawkes.com/2010/04/09/pop-everything/):
+
+**Purpose**: teach NASA Openscapes Mentors a workflow with Quarto and branch/pull requests. For contributing to Cookbook but also anything. Invite other Openscapes Mentors as a way to re-connect and skillbuild. 
+
+**Outcomes**: Mentors build skills, more empowered/equipped for contributing. Also we have a new clinic we can reuse. 
+
+**Process**: teach in late June, start with NASA Mentors to find a date (stand-alone, not part of our normal meetings?). Stef to lead design & teaching. Create 2 short Google Slide decks, design the activities.
+
+-   1: Targeted intro to Quarto
+
+-   2: GitHub Workflow: How to make a branch, (draft) pull request, communicate what you’re doing

_freeze/demo/execute-results/html.json

@@ -0,0 +1,14 @@
+{
+  "hash": "2def162349f6d494141457688bd978df",
+  "result": {
+    "markdown": "---\ntitle: \"`.qmd` file for practice\"\n---\n\n\nThis `demo.qmd` file has [Markdown](https://quarto.org/docs/authoring/markdown-basics.html)-formatted text, examples for adding headers, hyperlinks, and inserting images with alt-text, and a Python code chunk.\n\n-   Headers are powerful in Quarto because they let you organize on the side of the page. In a Quarto site, headers let you share a specific section of a page by clicking on a header and copying the URL.\n-   Hyperlinking lets us cite our sources and inspirations and give credit.\n-   Python code in a `.qmd` file will be executed automatically.\n\nWe can all practice Markdown in this Quarto file. Make an edit, preview how it will look in the site (`quarto preview`), edit, repeat.\n\nOnly make changes to the section below under *your* name header (to prevent conflicts with other people's edits)\n\n## Ideas for contributions\n\n#### Headers\n\nWe can make headers using `## Name`, `### Name`, etc. Headers are powerful in Quarto because they let you organize your content. You can share a specific subsection of a page by copying its URL.\n\n#### Hyperlinks\n\nWe can make hyperlinks using the `[]()` pattern: you name the hyperlink in `[]` and put the URL in `()`. For example, here's a link to [Markdown Basics](https://quarto.org/docs/authoring/markdown-basics.html). Hyperlinking lets us cite and give credit to our sources, like the NASA Earthdata Cloud Cookbook ([Barrett et al.](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/)).\n\n#### Images\n\nWe can include an image with the same `[]()` pattern, by adding a preceding exclamation point: `![]()`. The `[]` contain the caption (optional) and `()` contain the path to the image file.\n\nAdditional attributes like image size, alt text, and linking the image to a URL, are set inside `{}` in this example:\n\n`![The Openscapes logo](/images/openscapes_hex.png){fig-alt=\"Openscapes logo. A hexagonal shape with orange border, yellow background, the word openscapes in orange above a cartoon evoking a landscape of data plots\" width=\"35%\"}`\n\n![The Openscapes logo](/images/openscapes_hex.png){fig-alt=\"Openscapes logo. A hexagonal shape with orange border, yellow background, the word openscapes in orange above a cartoon evoking a landscape of data plots\" width=\"35%\"}\n\n#### Code\n\nWhen you **Render**, a document will be generated that includes both content and the output of embedded code. You can embed code like this:\n\n*TODO: day before clinic, make this Python code (don't add screenshot - fewer files to for folks to get distracted with, lighter weight repo)*\n\n\n::: {.cell}\n\n```{.r .cell-code}\n2 * 2\n```\n\n::: {.cell-output .cell-output-stdout}\n```\n[1] 4\n```\n:::\n:::\n\n\nYou can add options to executable code. The `echo: false` option disables the printing of code (only output is displayed).\n\n## Stefanie\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Alexis\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Andy\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Eric\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Guoqing\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Ian\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Jessica\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Juan\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Julie\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Katherine\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Kytt\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Luis\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Michele\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Navaneeth\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Rhys \n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Ritika\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Rupesh\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Roosevelt\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n\n## Scott\n\nFor your first edit, you could fix this tpyo and preview how it will look in the site.\n",
+    "supporting": [],
+    "filters": [
+      "rmarkdown/pagebreak.lua"
+    ],
+    "includes": {},
+    "engineDependencies": {},
+    "preserve": {},
+    "postProcess": true
+  }
+}

_quarto.yml

@@ -0,0 +1,62 @@
+project: 
+  type: website
+  output-dir: _site
+
+execute:
+  freeze: true  # never re-execute computational content during project render, needed for .qmd and .rmd since quarto does not render .ipynb by default  
+
+website: 
+  page-navigation: true
+  title: "Quarto Contributing Clinic" 
+  site-url: https://openscapes.github.io/quarto-clinic/ 
+  repo-url: https://github.com/Openscapes/quarto-clinic 
+  repo-actions: [edit, source, issue]
+
+  page-footer:
+    right: "This page is built with ❤️ and [Quarto](https://quarto.org/)."
+    left: "© CC-By Openscapes, 2024"
+
+  sidebar:
+    logo: "images/openscapes_hex.png"
+    pinned: true
+    align: center
+    tools: 
+      - icon: globe
+        href: https://openscapes.org
+        text: "Openscapes.org"
+      - icon: github
+        href: https://github.com/Openscapes/quarto-clinic
+        text: "Quarto Contributing Clinic repo"
+
+    style: "docked"
+    search: true
+    collapse-level: 1
+    contents:
+      - href: index.qmd
+        text: Welcome
+      - href: part0-setup.qmd
+        text: Setup
+      - section: part1-quarto.qmd
+        text: "Part 1: Quarto workflow"
+        contents: 
+          - demo.qmd
+      - href: part2-github.qmd
+        text: "Part 2: GitHub workflow"        
+      - href: next-steps.qmd
+        text: Next Steps
+
+
+format:
+  html:
+    theme:
+      light: [cosmo, theme.scss] # from https://github.com/sta210-s22/website/blob/main/_quarto.yml
+      dark: [cosmo, theme-dark.scss]
+    code-copy: true
+    code-overflow: wrap
+    toc: true
+
+
+filters:
+  - quarto
+
+