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 20, 2024
1 parent 49fef1f commit 6ad20eb
Show file tree
Hide file tree
Showing 14 changed files with 213 additions and 305 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
88c24145
36cd59d3
Binary file removed images/quarto-yml-site-side-by-side3.png
View file
Binary file not shown.
61 changes: 21 additions & 40 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,6 @@
<a href="./lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./lessons/demo.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand All @@ -169,9 +163,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="#purpose-outcomes-process-pop" id="toc-purpose-outcomes-process-pop" class="nav-link" data-scroll-target="#purpose-outcomes-process-pop">Purpose, Outcomes, Process (POP)</a></li>
<li><a href="#what-is-quarto" id="toc-what-is-quarto" class="nav-link" data-scroll-target="#what-is-quarto">What is Quarto?</a></li>
<li><a href="#example-quarto-sites" id="toc-example-quarto-sites" class="nav-link" data-scroll-target="#example-quarto-sites">Example Quarto sites</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>
</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 @@ -204,37 +196,26 @@ <h2 class="anchored" data-anchor-id="welcome">Welcome</h2>
<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>
</section>
<section id="purpose-outcomes-process-pop" class="level2">
<h2 class="anchored" data-anchor-id="purpose-outcomes-process-pop">Purpose, Outcomes, Process (<a href="https://suzannehawkes.com/2010/04/09/pop-everything/">POP</a>)</h2>
<p><strong>Purpose:</strong> NASA Openscapes Mentors learn workflows with Quarto and GitHub for contributing to the <a href="https://nasa-openscapes.github.io/earthdata-cloud-cookbook/">NASA Earthdata Cloud Cookbook</a> or any site or book made with Quarto. An opportunity for Mentors to connect and skill-build together.</p>
<p><strong>Outcomes:</strong> Mentors build skills and are more equipped and empowered to contribute. This is a new clinic we can reuse and build on.</p>
<p><strong>Process:</strong> 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 &amp; 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.</p>
<ol type="1">
<li><p>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.</p></li>
<li><p>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.</p></li>
</ol>
</section>
<section id="what-is-quarto" class="level2">
<h2 class="anchored" data-anchor-id="what-is-quarto">What is Quarto?</h2>
<p>Quarto helps you have your ideas and your code in one place, and present it in a beautiful way.</p>
<blockquote class="blockquote">
<p>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.</p>
</blockquote>
<p>Quarto can be used to create dynamic content with Python, R, Julia, and Observable through your favorite IDE like JupyterHub or RStudio. 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.</p>
<p><a href="https://quarto.org">Quarto.org</a> is the go-to place for full documentation and more tutorials!</p>
</section>
<section id="example-quarto-sites" class="level2">
<h2 class="anchored" data-anchor-id="example-quarto-sites">Example Quarto sites</h2>
<ul>
<li><a href="https://nasa-openscapes.github.io/">NASA Openscapes</a></li>
<li><a href="https://nasa-openscapes.github.io/earthdata-cloud-cookbook/">NASA Earthdata Cloud Cookbook</a></li>
<li><a href="https://nasa-openscapes.github.io/2021-Cloud-Hackathon/">2021 NASA Cloud Hackathon</a></li>
<li><a href="https://openscapes.github.io/series">Openscapes Champions Lessons Series</a></li>
<li><a href="https://openscapes.github.io/approach-guide/">Openscapes Approach Guide</a></li>
<li><a href="https://thefaylab.github.io/lab-manual/">Faylab Lab Manual</a></li>
<li><a href="https://mine-cetinkaya-rundel.github.io/quarto-tip-a-day/">A Quarto tip a day</a>, by Mine Çetinkaya-Rundel</li>
</ul>
<p>See many more examples at the <a href="https://quarto.org/docs/gallery/">Quarto gallery</a>!</p>
<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>This requires some setup. We’ll do this first, and discuss more as we go.</p>
<!--- TOCUT or move
## What is Quarto?
Quarto 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. 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.
[Quarto.org](https://quarto.org) is the go-to place for full documentation and more tutorials!
--->


</section>
Expand Down
28 changes: 4 additions & 24 deletions lessons/demo.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
<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="../lessons/part2-github.html" rel="next">
<link href="../lessons/part1-quarto.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 @@ -82,7 +80,7 @@
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../lessons/index.html">Lessons</a></li><li class="breadcrumb-item"><a href="../lessons/demo.html">demo.qmd practice file</a></li></ol></nav>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><code>demo.qmd</code> Quarto Practice</li></ol></nav>
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target=".quarto-sidebar-collapse-item" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
Expand Down Expand Up @@ -128,22 +126,16 @@
<div class="sidebar-item-container">
<a href="../lessons/index.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Lessons</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
<a class="sidebar-item-toggle text-start collapsed" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="false" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 ">
<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">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/demo.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -182,7 +174,7 @@ <h2 id="toc-title">On this page</h2>
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default"><nav class="quarto-page-breadcrumbs quarto-title-breadcrumbs d-none d-lg-block" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="../lessons/index.html">Lessons</a></li><li class="breadcrumb-item"><a href="../lessons/demo.html">demo.qmd practice file</a></li></ol></nav>
<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title"><code>demo.qmd</code> Quarto Practice</h1>
</div>
Expand Down Expand Up @@ -832,18 +824,6 @@ <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="Edit a Quarto site">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Edit a Quarto site</span>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../lessons/part2-github.html" class="pagination-link" aria-label="Contribute via GitHub">
<span class="nav-page-text">Contribute via GitHub</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
</div> <!-- /content -->
<footer class="footer">
<div class="nav-footer">
Expand Down
21 changes: 1 addition & 20 deletions lessons/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,6 @@
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/demo.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand All @@ -203,8 +197,7 @@
<h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#basic-workflow" id="toc-basic-workflow" class="nav-link active" data-scroll-target="#basic-workflow">Basic Workflow</a></li>
<li><a href="#authoring" id="toc-authoring" class="nav-link" data-scroll-target="#authoring">Authoring</a></li>
<li><a href="#authoring" id="toc-authoring" class="nav-link active" data-scroll-target="#authoring">Authoring</a></li>
<li><a href="#update-_quarto.yml" id="toc-update-_quarto.yml" class="nav-link" data-scroll-target="#update-_quarto.yml">Update <code>_quarto.yml</code></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>
Expand Down Expand Up @@ -232,18 +225,6 @@ <h1 class="title">Practice</h1>


<p><em>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</em></p>
<section id="basic-workflow" class="level2">
<h2 class="anchored" data-anchor-id="basic-workflow">Basic Workflow</h2>
<p>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.</p>
<ol type="1">
<li>Authoring: write text, code, images, etc in a file. Supported files include <code>.md</code>, <code>.Rmd</code>, <code>.qmd</code>, <code>.ipynb</code>…</li>
<li>Update <code>_quarto.yml</code> as needed (for example, if you’ve created a new file you’d like included in your site)</li>
<li>Render individual files and/or the whole website</li>
<li>Repeat, repeat, repeat</li>
<li>Commit and push your updates to GitHub, they will publish automatically!</li>
<li>Repeat all of the above to make the website as you’d like!</li>
</ol>
</section>
<section id="authoring" class="level2">
<h2 class="anchored" data-anchor-id="authoring">Authoring</h2>
<p><em>TODO: Move to “Edit a Quarto site”</em></p>
Expand Down
6 changes: 0 additions & 6 deletions lessons/newfile.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,6 @@
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/demo.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down
12 changes: 3 additions & 9 deletions lessons/part1-quarto.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,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="../lessons/demo.html" rel="next">
<link href="../lessons/part2-github.html" rel="next">
<link href="../lessons/index.html" rel="prev">
<script src="../site_libs/quarto-html/quarto.js"></script>
<script src="../site_libs/quarto-html/popper.min.js"></script>
Expand Down Expand Up @@ -172,12 +172,6 @@
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/demo.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -954,8 +948,8 @@ <h2 class="anchored" data-anchor-id="onward">Onward</h2>
</a>
</div>
<div class="nav-page nav-page-next">
<a href="../lessons/demo.html" class="pagination-link" aria-label="demo.qmd practice file">
<span class="nav-page-text">demo.qmd practice file</span> <i class="bi bi-arrow-right-short"></i>
<a href="../lessons/part2-github.html" class="pagination-link" aria-label="Contribute via GitHub">
<span class="nav-page-text">Contribute via GitHub</span> <i class="bi bi-arrow-right-short"></i>
</a>
</div>
</nav>
Expand Down
12 changes: 3 additions & 9 deletions lessons/part2-github.html
View file
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="../next-steps.html" rel="next">
<link href="../lessons/demo.html" rel="prev">
<link href="../lessons/part1-quarto.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 @@ -138,12 +138,6 @@
<a href="../lessons/part1-quarto.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Edit a Quarto site</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../lessons/demo.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">demo.qmd practice file</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
Expand Down Expand Up @@ -860,8 +854,8 @@ <h2 class="anchored" data-anchor-id="review-a-pull-request">Review a pull reques
</script>
<nav class="page-navigation">
<div class="nav-page nav-page-previous">
<a href="../lessons/demo.html" class="pagination-link" aria-label="demo.qmd practice file">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">demo.qmd practice file</span>
<a href="../lessons/part1-quarto.html" class="pagination-link" aria-label="Edit a Quarto site">
<i class="bi bi-arrow-left-short"></i> <span class="nav-page-text">Edit a Quarto site</span>
</a>
</div>
<div class="nav-page nav-page-next">
Expand Down
Loading

0 comments on commit 6ad20eb

Please sign in to comment.