Skip to content

Commit

Permalink
Merge pull request #18 from Openscapes/intro
Browse files Browse the repository at this point in the history
update Welcome, POP, what is quarto
  • Loading branch information
stefaniebutland authored Jun 16, 2024
2 parents 5f7c3df + 6ba7053 commit e8e010e
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 15 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quarto Contributing Clinic
# Quarto + GitHub Contributing Clinic

A book that is a 1hr session to teach folks how to contribute to existing Quarto sites & books. Analogous to our [GitHub Clinic](https://openscapes.github.io/series/core-lessons/github/) with 2x short slide decks and activities.
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/):

Expand Down
37 changes: 24 additions & 13 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,53 @@
title: "Contributing to Quarto websites and books"
subtitle: "Share open-source tutorials, onboarding docs, and much more"
---
*TODO: edit Welcome page to include POP, What is Quarto. Brief. Move to Setup & Explore*

## Welcome

It's possible to create beautiful documentation to share online with [Quarto](https://quarto.org) that auto-updates with [GitHub](http://github.com). This is very new and incredibly cool. This tutorial is an example of a quarto website --- it is a really powerful way to create and share your work. You can communicate about science using the same reproducible workflow you and/or your colleagues use for analyses, whether or not you write code.
It's possible to create beautiful documentation to share online with [Quarto](https://quarto.org) that auto-updates with [GitHub](http://github.com). This is fairly new and incredibly cool. This Clinic is an example of a Quarto website --- a really powerful way to create and share your work. You can communicate about science using the same reproducible workflow you and/or your colleagues use for analyses, whether or not you write code.

Creating websites with Quarto can be done without knowing R, Python or HTML, CSS, etc, and that's where we'll start. However, Quarto integrates with these tools so you can make your websites as complex and beautiful as you like as you see examples and reuse and remix from others in the open community. This tutorial borrows heavily from a lot of great tutorials and resources you should check out too -- there are links throughout.
Creating and editing websites with Quarto can be done without knowing R, Python or HTML, CSS, etc, however, Quarto integrates with these tools so you can make your websites as complex and beautiful as you like as you see examples and reuse and remix from others in the open science community.

## What is Quarto?
**To begin**, you should have a GitHub account with access to the 2i2c Openscapes JupyterHub.

Quarto helps you have your ideas and your code in one place, and present it in a beautiful way.
## Purpose, Outcomes, Process ([POP](https://suzannehawkes.com/2010/04/09/pop-everything/))

**Quarto unifies and extends the RMarkdown ecosystem** - it unifies by combining the functionality of R Markdown, bookdown, distill, xaringian, etc into a single consistent system. And it extends in several ways: all features are possible beyond R too, including Python and Javascript. It also has more “guardrails”: accessibility and inclusion are centered in the design. Quarto is for people who love RMarkdown, and it's for people who have never used RMarkdown.
**Purpose:** NASA Openscapes Mentors learn workflows with Quarto and GitHub for contributing to the [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/) or any site or book made with Quarto. An opportunity for Mentors to connect and skill-build together.

*TODO: add Cookbook below*
**Outcomes:** Mentors build skills and are more equipped and empowered to contribute. This is a new clinic we can reuse and build on.

The ability for Quarto to streamline collaboration has been so cool and important for our [NASA Openscapes](https://nasa-openscapes.github.io/) project. Quarto has been a common place for us to collaborate - across R and Python languages and coding expertise.
**Process:** A 1.5-hr clinic with demo's and hands-on practice to guide folks through contributing to existing Quarto sites & books. Analogous to our GitHub Clinic. The clinic content is contained in this website that is built with Quarto on GitHub; there are no accompanying slide decks.

## What is this tutorial?
1. Introduction to Quarto using the 2i2c Openscapes JupyterHub.

This is a 1.5-hour tutorial that can be used to teach or as self-paced learning.
2. GitHub Workflow: How to clone the repo for this site, make a branch to work in, edit, commit and push your edits to GitHub, make a pull request, review and merge a pull request, and communicate what you’re doing at each step.

We introduce Quarto by exploring this clinic website, and practicing the basic Quarto workflow using the 2i2c Openscapes JupyterHub for editing your website and GitHub in the browser to review proposed updates.
## What is Quarto?

[Quarto](https://quarto.org) helps you have your ideas and your code in one place, and present it in a beautiful way.

> Quarto is an open-source scientific and technical publishing system built on Pandoc. You can weave together narrative text and code to produce elegantly formatted output as documents, web pages, blog posts, books, presentations, and more.
Quarto can be used to create dynamic content with Python, R, Julia, and Observable through your favorite IDE like JupyterHub or RStudio.

The ability for Quarto to streamline collaboration has been so cool and important for our [NASA Openscapes](https://nasa-openscapes.github.io/) project. Quarto is a common place for us to collaborate - across Python and R languages and varied levels of coding expertise and accessibility and inclusion are centered in the Quarto design.

## What is this Clinic?

This is a 1.5-hour clinic that can be used to teach or as self-paced learning.

We introduce Quarto by exploring this clinic website, and practicing the basic Quarto workflow using the 2i2c Openscapes JupyterHub for editing your website and GitHub in the browser to review proposed updates.

[Quarto.org](https://quarto.org) is the go-to place for full documentation and more tutorials!

## Example Quarto sites

A few Quarto websites from Openscapes - so far we have been using Quarto for documentation using Quarto and Markdown files and Jupyter Notebooks.

- [Champions Lessons Series](https://openscapes.github.io/series)
- [Openscapes Approach Guide](https://openscapes.github.io/approach-guide/)
- [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/)
- [2021 NASA Cloud Hackathon](https://nasa-openscapes.github.io/2021-Cloud-Hackathon/)
- [Champions Lessons Series](https://openscapes.github.io/series)
- [Openscapes Approach Guide](https://openscapes.github.io/approach-guide/)
- [Faylab Lab Manual](https://thefaylab.github.io/lab-manual/)
- [A Quarto tip a day](https://mine-cetinkaya-rundel.github.io/quarto-tip-a-day/), by Mine Çetinkaya-Rundel

Expand Down

0 comments on commit e8e010e

Please sign in to comment.