Skip to content

Commit

Permalink
Merge pull request #30 from Openscapes/julie-jun-19
Browse files Browse the repository at this point in the history
Julie comments June 19
  • Loading branch information
stefaniebutland authored Jun 20, 2024
2 parents 07316ce + b76f56e commit 08f0fe9
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 146 deletions.
5 changes: 2 additions & 3 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ website:
contents:
- href: lessons/part1-quarto.qmd
text: Edit a Quarto site
- href: lessons/demo.qmd
text: demo.qmd practice file
# - href: lessons/demo.qmd
# text: demo.qmd practice file
- href: lessons/part2-github.qmd
text: Contribute via GitHub
- href: next-steps.qmd
Expand All @@ -60,7 +60,6 @@ format:


filters:
- include-files.lua
- quarto


115 changes: 0 additions & 115 deletions include-files.lua

This file was deleted.

25 changes: 9 additions & 16 deletions index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,19 @@ The ability for Quarto to streamline collaboration has been so cool and importan

**To begin**, you should have a GitHub account with access to the 2i2c Openscapes JupyterHub.

## Purpose, Outcomes, Process ([POP](https://suzannehawkes.com/2010/04/09/pop-everything/))
## Our Plan today

**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.
We will learn workflows with Quarto and GitHub for contributing to open source documentation - like the [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/).

**Outcomes:** Mentors build skills and are more equipped and empowered to contribute. This is a new clinic we can reuse and build on.
This is a 1.5-hr clinic that has demos and time for hands-on practice in breakout rooms.

**Process:** A 1.5-hr clinic that can be used to teach or as self-paced learning. 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.
**Part 1. Quarto Workflow:** Use the 2i2c Openscapes JupyterHub to explore this clinic website and its source repository on GitHub, practice contributing to this site by editing a Quarto file or adding a new Jupyter Notebook and previewing the changes.

1. Quarto Workflow: Use the 2i2c Openscapes JupyterHub to explore this clinic website and its source repository on GitHub, practice contributing to this site by editing a Quarto file or adding a new Jupyter Notebook and previewing the changes.
**Part 2. GitHub Workflow:** Clone the repository 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.

2. GitHub Workflow: Clone the repository 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.
This requires some setup. We'll do this first, and discuss more as we go.

<!--- TOCUT or move
## What is Quarto?
Expand All @@ -33,14 +35,5 @@ Quarto can be used to create dynamic content with Python, R, Julia, and Observab
[Quarto.org](https://quarto.org) is the go-to place for full documentation and more tutorials!
## Example Quarto sites

- [NASA Openscapes](https://nasa-openscapes.github.io/)
- [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/)
- [2021 NASA Cloud Hackathon](https://nasa-openscapes.github.io/2021-Cloud-Hackathon/)
- [Openscapes 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
--->

See many more examples at the [Quarto gallery](https://quarto.org/docs/gallery/)!
11 changes: 0 additions & 11 deletions lessons/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,6 @@ title: Practice

*TODO: Drastically reduce this page's text. Get to the doing. This index page should say, hey here's 2 things we'll practice - Edit a Quarto site, and Contribute via GitHub. Here's the Basic Workflow*

## Basic Workflow

How do you work in Quarto? You can use whichever tool you're comfortable with (Jupyter, RStudio, GitHub, VS Code, etc). Developing your Quarto site will have the same basic workflow, no matter which tool you use. It is very iterative.

1. Authoring: write text, code, images, etc in a file. Supported files include `.md`, `.Rmd`, `.qmd`, `.ipynb`...
2. Update `_quarto.yml` as needed (for example, if you've created a new file you'd like included in your site)
3. Render individual files and/or the whole website
4. Repeat, repeat, repeat
5. Commit and push your updates to GitHub, they will publish automatically!
6. Repeat all of the above to make the website as you'd like!

## Authoring

*TODO: Move to "Edit a Quarto site"*
Expand Down
13 changes: 13 additions & 0 deletions next-steps.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,16 @@ We can use these skills to contribute to many Quarto websites and books.
- e.g. add a link to your slides or recording of a presentation
- [Openscapes Approach Guide](https://openscapes.github.io/approach-guide/)
- [Openscapes Champions Lessons Series](https://openscapes.github.io/series)


## Example Quarto sites

- [NASA Openscapes](https://nasa-openscapes.github.io/)
- [NASA Earthdata Cloud Cookbook](https://nasa-openscapes.github.io/earthdata-cloud-cookbook/)
- [2021 NASA Cloud Hackathon](https://nasa-openscapes.github.io/2021-Cloud-Hackathon/)
- [Openscapes 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

See many more examples at the [Quarto gallery](https://quarto.org/docs/gallery/)!
21 changes: 20 additions & 1 deletion setup-explore.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Most of these are pages, but you'll see that "Lessons" has an arrow `>`; it is a

### The website's source repo

*TODO: If we will make a new repo for every Clinic, we'll need to update the repo link below, every time.*
<!---
*TODO: If we will make a new repo for every Clinic, we'll need to update the repo link below, every time. Good to keep in mind; we'll figure out an approach where we don't need to update here every time...*
--->

Let's go to this website's GitHub repository (or "repo"), <https://github.com/Openscapes/quarto-clinic>. You can also click there from any page in this clinic website by clicking the GitHub Octocat icon underneath the Openscapes logo in the left navbar.

Expand All @@ -54,6 +56,21 @@ To open a link in a new browser tab, hold command on Mac, or control on a PC, th

![quarto-website-tutorial GitHub repository with files for webpages marked with red arrows](images/quarto-files-github.png){fig-alt="Screenshot of files on GitHub with red arrows identifying the files that we saw in the left sidebar" fig-align="center" width="80%"}

### Quarto Basic Workflow

Quarto is an open-source scientific and technical publishing system You can weave together narrative text and code to produce elegantly formatted output as documents, web pages, blog posts, books, presentations, and more.

How do you work in Quarto? You can use whichever tool you're comfortable with (Jupyter, RStudio, GitHub, VS Code, etc). Developing your Quarto site will have the same basic workflow, no matter which tool you use. It is very iterative.

1. Authoring: write text, code, images, etc in a file. Supported files include `.md`, `.Rmd`, `.qmd`, `.ipynb`...
2. Update `_quarto.yml` as needed (for example, if you've created a new file you'd like included in your site) <!---I think this still works even without exploring _quarto.yml yet --->
3. Render individual files and/or the whole website
4. Repeat, repeat, repeat
5. Commit and push your updates to GitHub, they will publish automatically!
6. Repeat all of the above to make the website as you'd like!


<!--- TOCUT or MOVE - This feeels like too much for the intro here.
### `_quarto.yml` intro
There is also a `_quarto.yml` file, which is the website's configuration file. It is essentially metadata for the website that includes the order that the pages / sections will be in. This is where we can update the organization of our website: which page comes before another, and how pages are named in the navbar. If we compare the repo and website side-by-side, we'll see that the pages that appear on our website are listed there.
Expand All @@ -62,6 +79,8 @@ There is also a `_quarto.yml` file, which is the website's configuration file. I
We'll learn more about how to interact with `_quarto.yml` in the [Lessons](lessons/index.qmd).
--->

## Setup Part 2: Clone the Quarto Clinic repo

After our Hub server has loaded (Setup Part 1), we'll clone the Quarto Clinic repository into the Hub.
Expand Down

0 comments on commit 08f0fe9

Please sign in to comment.