Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Jun 25, 2024
1 parent f7b7fe1 commit 596cad2
Show file tree
Hide file tree
Showing 16 changed files with 273 additions and 378 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
207cf1d3
95070976
Binary file added images/horst_quarto_schematic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 24 additions & 15 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<script src="site_libs/quarto-search/fuse.min.js"></script>
<script src="site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="./">
<link href="./setup-explore.html" rel="next">
<link href="./setup.html" rel="next">
<script src="site_libs/quarto-html/quarto.js"></script>
<script src="site_libs/quarto-html/popper.min.js"></script>
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
Expand Down Expand Up @@ -119,8 +119,8 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./setup-explore.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup &amp; Explore</span></a>
<a href="./setup.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
Expand All @@ -135,7 +135,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 1: Edit a Quarto site</span></a>
<span class="menu-text">Part 1: Quarto workflow</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -147,7 +147,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./lessons/part2-github.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 2: Contribute via GitHub</span></a>
<span class="menu-text">Part 2: GitHub workflow</span></a>
</div>
</li>
</ul>
Expand All @@ -170,6 +170,7 @@ <h2 id="toc-title">On this page</h2>
<ul>
<li><a href="#welcome" id="toc-welcome" class="nav-link active" data-scroll-target="#welcome">Welcome</a></li>
<li><a href="#our-plan-today" id="toc-our-plan-today" class="nav-link" data-scroll-target="#our-plan-today">Our Plan today</a></li>
<li><a href="#prerequisites" id="toc-prerequisites" class="nav-link" data-scroll-target="#prerequisites">Prerequisites</a></li>
</ul>
<div class="toc-actions"><ul><li><a href="https://github.com/Openscapes/quarto-clinic/edit/main/index.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/blob/main/index.qmd" class="toc-action"><i class="bi empty"></i>View source</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
</div>
Expand Down Expand Up @@ -198,18 +199,26 @@ <h1 class="title">Quarto + GitHub Clinic</h1>

<section id="welcome" class="level2">
<h2 class="anchored" data-anchor-id="welcome">Welcome</h2>
<p>It’s possible to create beautiful documentation to share online with <a href="https://quarto.org">Quarto</a> that auto-updates with <a href="http://github.com">GitHub</a>. 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 or your colleagues use for analyses, whether or not you write code.</p>
<p>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.</p>
<p>The ability for Quarto to streamline collaboration has been so cool and important for our <a href="https://nasa-openscapes.github.io/">NASA Openscapes</a> 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.</p>
<p><strong>To begin</strong>, you should have a GitHub account with access to the 2i2c Openscapes JupyterHub.</p>
<p>This book is an example of a Quarto website that is published via GitHub - these are powerful workflows to create and share your work.</p>
<p>Quarto lets us build websites as a collection of files (<code>.qmd</code>, <code>.ipynb</code>, <code>.rmd</code> and others). Today we’ll focus on <code>.qmd</code> files, which are plain-text files that work nicely with GitHub workflows.</p>
<p>Quarto enables us to collaborate on documentation and tutorials - across Python and R languages and varied levels of coding expertise. Importantly, it lets us write and share documentation/tutorials using the same tools we teach research teams for reproducible science.</p>
<p>The ability for Quarto to streamline collaboration has been so cool and important for our <a href="https://nasa-openscapes.github.io/">NASA Openscapes</a> project, so this tutorial will enable you to contribute to that site as well as the <a href="https://nasa-openscapes.github.io/earthdata-cloud-cookbook/">NASA Earthdata Cloud Cookbook</a> (both made with Quarto+GitHub.)</p>
<div class="quarto-figure quarto-figure-center">
<figure class="figure">
<p><img src="images/horst_quarto_schematic.png" class="img-fluid quarto-figure quarto-figure-center figure-img" alt="3 part illustration left-to-right that starts with R, Python, Julia, Observable and more pointing to Quarto and then pointing to html, pdf, and word documents" width="1100"></p>
</figure>
</div>
</section>
<section id="our-plan-today" class="level2">
<h2 class="anchored" data-anchor-id="our-plan-today">Our Plan today</h2>
<p>We will learn workflows with Quarto and GitHub for contributing to open source documentation - like the <a href="https://nasa-openscapes.github.io/earthdata-cloud-cookbook/">NASA Earthdata Cloud Cookbook</a>.</p>
<p>This is a 1.5-hr clinic that has demos and time for hands-on practice in breakout rooms.</p>
<p><strong>Part 1. Quarto Workflow:</strong> 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.</p>
<p><strong>Part 2. GitHub Workflow:</strong> 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.</p>
<p>We will learn workflows with Quarto and GitHub for contributing to open source documentation. We’ll cover contributing in 2 parts:</p>
<p><strong>Part 1. Quarto Workflow:</strong> Use the 2i2c Openscapes JupyterHub as an editor: we will contribute to this Quarto site by editing a <code>.qmd</code> file and previewing the changes.</p>
<p><strong>Part 2. GitHub Workflow:</strong> Clone the repository for this site, make a branch to work in, 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.</p>
<p>This requires some setup. We’ll do this first, and discuss more as we go.</p>
</section>
<section id="prerequisites" class="level2">
<h2 class="anchored" data-anchor-id="prerequisites">Prerequisites</h2>
<p><strong>To begin</strong>, you should have a GitHub account with access to the 2i2c Openscapes JupyterHub.</p>


</section>
Expand Down Expand Up @@ -772,8 +781,8 @@ <h2 class="anchored" data-anchor-id="our-plan-today">Our Plan today</h2>
<div class="nav-page nav-page-previous">
</div>
<div class="nav-page nav-page-next">
<a href="./setup-explore.html" class="pagination-link" aria-label="Setup &amp; Explore">
<span class="nav-page-text">Setup &amp; Explore</span> <i class="bi bi-arrow-right-short"></i>
<a href="./setup.html" class="pagination-link" aria-label="Setup">
<span class="nav-page-text">Setup</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand Down
16 changes: 8 additions & 8 deletions lessons/demo.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../setup-explore.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup &amp; Explore</span></a>
<a href="../setup.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
Expand All @@ -136,7 +136,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 1: Edit a Quarto site</span></a>
<span class="menu-text">Part 1: Quarto workflow</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -148,7 +148,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/part2-github.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 2: Contribute via GitHub</span></a>
<span class="menu-text">Part 2: GitHub workflow</span></a>
</div>
</li>
</ul>
Expand Down Expand Up @@ -834,13 +834,13 @@ <h2 class="anchored" data-anchor-id="your-turn">Your turn!</h2>
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../lessons/part1-quarto.html" class="pagination-link" aria-label="Part 1: Edit a Quarto site">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Part 1: Edit a Quarto site</span>
<a href="../lessons/part1-quarto.html" class="pagination-link" aria-label="Part 1: Quarto workflow">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Part 1: Quarto workflow</span>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../lessons/part2-github.html" class="pagination-link" aria-label="Part 2: Contribute via GitHub">
<span class="nav-page-text">Part 2: Contribute via GitHub</span> <i class="bi bi-arrow-right-short"></i>
<a href="../lessons/part2-github.html" class="pagination-link" aria-label="Part 2: GitHub workflow">
<span class="nav-page-text">Part 2: GitHub workflow</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand Down
Binary file removed lessons/images/jupyter-execute-cell.png
Binary file not shown.
Binary file removed lessons/images/jupyter-python-example.png
Binary file not shown.
Binary file removed lessons/images/jupyter-raw-chunk.png
Binary file not shown.
Binary file removed lessons/images/jupyter-side-by-side.png
Binary file not shown.
Binary file removed lessons/images/quarto-yml-site-side-by-side3.png
Binary file not shown.
64 changes: 19 additions & 45 deletions lessons/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<script src="../site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="../">
<link href="../lessons/part1-quarto.html" rel="next">
<link href="../setup-explore.html" rel="prev">
<link href="../setup.html" rel="prev">
<script src="../site_libs/quarto-html/quarto.js"></script>
<script src="../site_libs/quarto-html/popper.min.js"></script>
<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
Expand Down Expand Up @@ -120,8 +120,8 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../setup-explore.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup &amp; Explore</span></a>
<a href="../setup.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Setup</span></a>
</div>
</li>
<li class="sidebar-item sidebar-item-section">
Expand All @@ -136,7 +136,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 1: Edit a Quarto site</span></a>
<span class="menu-text">Part 1: Quarto workflow</span></a>
</div>
</li>
<li class="sidebar-item">
Expand All @@ -148,7 +148,7 @@
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/part2-github.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Part 2: Contribute via GitHub</span></a>
<span class="menu-text">Part 2: GitHub workflow</span></a>
</div>
</li>
</ul>
Expand All @@ -165,15 +165,7 @@
<div id="quarto-sidebar-glass" class="quarto-sidebar-collapse-item" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#workflow-to-edit-a-quarto-site-source" id="toc-workflow-to-edit-a-quarto-site-source" class="nav-link active" data-scroll-target="#workflow-to-edit-a-quarto-site-source">Workflow to edit a Quarto site source</a></li>
<li><a href="#workflow-to-contribute-via-github" id="toc-workflow-to-contribute-via-github" class="nav-link" data-scroll-target="#workflow-to-contribute-via-github">Workflow to contribute via GitHub</a></li>
<li><a href="#lets-try-these-workflows" id="toc-lets-try-these-workflows" class="nav-link" data-scroll-target="#lets-try-these-workflows">Let’s try these workflows!</a></li>
</ul>
<div class="toc-actions"><ul><li><a href="https://github.com/Openscapes/quarto-clinic/edit/main/lessons/index.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/blob/main/lessons/index.qmd" class="toc-action"><i class="bi empty"></i>View source</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>

</div>
<!-- main -->
<main class="content" id="quarto-document-content">
Expand All @@ -198,34 +190,16 @@ <h1 class="title">Practice</h1>


<p>In this section we’ll practice two workflows: <a href="../lessons/part1-quarto.html">Part 1: Edit a Quarto site</a>, and <a href="../lessons/part2-github.html">Part 2: Contribute via GitHub</a>. We include a basic workflow for each here, so you can come back to these for a reminder.</p>
<section id="workflow-to-edit-a-quarto-site-source" class="level2">
<h2 class="anchored" data-anchor-id="workflow-to-edit-a-quarto-site-source">Workflow to edit a Quarto site source</h2>
<ol type="1">
<li>Preview the site</li>
<li>Make changes to files; supported types include <code>.qmd</code>, <code>.ipynb</code> <code>.md</code>, <code>.Rmd</code>.</li>
<li>Save, preview</li>
<li>Update <code>_quarto.yml</code> file as needed to have new content appear in the site’s nav bar.</li>
</ol>
</section>
<section id="workflow-to-contribute-via-github" class="level2">
<h2 class="anchored" data-anchor-id="workflow-to-contribute-via-github">Workflow to contribute via GitHub</h2>
<ol type="1">
<li>Inspect the differences your edits will introduce</li>
<li>“Stage” your changes</li>
<li>Commit your changes with a helpful “Commit message”</li>
<li>“Push” to GitHub</li>
<li>Go to the Clinic repo source on GitHub, in your browser</li>
<li>Make a “Pull Request” and tag a reviewer</li>
<li>Reviewer responds by commenting, making suggested commits, and submitting their review</li>
<li>Author responds to review and “merges” their Pull Request</li>
<li>A GitHub Action automatically publishes the updates in the live siteDiff, Stage, Commit, and Push your edits to GitHub</li>
</ol>
</section>
<section id="lets-try-these-workflows" class="level2">
<h2 class="anchored" data-anchor-id="lets-try-these-workflows">Let’s try these workflows!</h2>
<!---
TODO: some overarching statement/illustration of: ("there's a lot of jargon/concepts:)
Quarto is a thing that lets you combine different file times we build to ... (preview, .qmd, and how they are built together)
GitHub is how we contribute to...
JupyterHub / terminal
Branches
--->


</section>

</main> <!-- /main -->
<script id="quarto-html-after-body" type="application/javascript">
Expand Down Expand Up @@ -783,13 +757,13 @@ <h2 class="anchored" data-anchor-id="lets-try-these-workflows">Let’s try these
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../setup-explore.html" class="pagination-link" aria-label="Setup &amp; Explore">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Setup &amp; Explore</span>
<a href="../setup.html" class="pagination-link" aria-label="Setup">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Setup</span>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../lessons/part1-quarto.html" class="pagination-link" aria-label="Part 1: Edit a Quarto site">
<span class="nav-page-text">Part 1: Edit a Quarto site</span> <i class="bi bi-arrow-right-short"></i>
<a href="../lessons/part1-quarto.html" class="pagination-link" aria-label="Part 1: Quarto workflow">
<span class="nav-page-text">Part 1: Quarto workflow</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand All @@ -801,7 +775,7 @@ <h2 class="anchored" data-anchor-id="lets-try-these-workflows">Let’s try these
</div>
<div class="nav-footer-center">
&nbsp;
<div class="toc-actions d-sm-block d-md-none"><ul><li><a href="https://github.com/Openscapes/quarto-clinic/edit/main/lessons/index.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/blob/main/lessons/index.qmd" class="toc-action"><i class="bi empty"></i>View source</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
<div class="toc-actions"><ul><li><a href="https://github.com/Openscapes/quarto-clinic/edit/main/lessons/index.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/blob/main/lessons/index.qmd" class="toc-action"><i class="bi empty"></i>View source</a></li><li><a href="https://github.com/Openscapes/quarto-clinic/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></div>
<div class="nav-footer-right">
<p>This page is built with ❤️ and <a href="https://quarto.org/">Quarto</a>.</p>
</div>
Expand Down
Loading

0 comments on commit 596cad2

Please sign in to comment.