Skip to content

Commit

Permalink
deploy: 17e74c8
Browse files Browse the repository at this point in the history
  • Loading branch information
@bast
bast committed Jun 23, 2024
0 parents commit f2d64f5
Show file tree
Hide file tree
Showing 370 changed files with 46,440 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 9dcaa43760524e132905f47abab52c23
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
Empty file added .nojekyll
Empty file.
161 changes: 161 additions & 0 deletions 1/browse/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Copy and browse an existing project &mdash; CodeRefinery mini-workshop documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=949a1ff5" />
<link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_lesson.css?v=0c089442" />
<link rel="stylesheet" type="text/css" href="../../_static/term_role_formatting.css?v=4194e21c" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_rtd_theme_ext_color_contrast.css?v=8e8ea19f" />
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=791bfbd6" />
<link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=a5c4661c" />


<link rel="shortcut icon" href="../../_static/coderefinery.ico"/>
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=187304be"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=582ca9e2"></script>
<script src="../../_static/minipres.js?v=a0d29692"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="../../_static/togglebutton.js?v=4a39c7ea"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script data-domain="coderefinery.github.io" defer="defer" src="https://plausible.cs.aalto.fi/js/script.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex/" />
<link rel="search" title="Search" href="../../search/" />
<link rel="next" title="Collaboration and code review using issues and pull requests" href="../code-review/" />
<link rel="prev" title="Motivation for version control" href="../motivation/" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../" class="icon icon-home">
CodeRefinery mini-workshop
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Session 1: Tracking changes</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../motivation/">Motivation for version control</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Copy and browse an existing project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code-review/">Collaboration and code review using issues and pull requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sharing/">How to turn your project to a Git repo and share it</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Session 2: Usability</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../2/documentation/">Code documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../2/testing/">Automated testing: from unit tests to end-to-end tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../2/structure/">How to structure the code as it grows</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Session 3: Sharing</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../3/reproducibility/">Reproducible dependencies, environments, and workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../3/software-licensing/">Choosing a software license</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../3/publishing/">How to publish your code</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../guide/">Guide for instructors and contributors</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/lessons/core/">All lessons</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/">CodeRefinery</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/lessons/reusing/">Reusing</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../">CodeRefinery mini-workshop</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Copy and browse an existing project</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/coderefinery/mini-workshop/blob/main/content/1/browse.md" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="copy-and-browse-an-existing-project">
<h1>Copy and browse an existing project<a class="headerlink" href="#copy-and-browse-an-existing-project" title="Link to this heading"></a></h1>
<div class="admonition-objectives objectives admonition" id="objectives-0">
<p class="admonition-title">Objectives</p>
<ul class="simple">
<li><p>We will fork the example project.</p></li>
<li><p>We will find a point in history when a code default changed (using <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">annotate</span></code>).</p></li>
<li><p>We will create a commit with a new file added to <code class="docutils literal notranslate"><span class="pre">exercise</span></code> directory.</p></li>
</ul>
</div>
<p>(work in progress on creating screenshots and commentary)</p>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../motivation/" class="btn btn-neutral float-left" title="Motivation for version control" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../code-review/" class="btn btn-neutral float-right" title="Collaboration and code review using issues and pull requests" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright CodeRefinery team.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
161 changes: 161 additions & 0 deletions 1/code-review/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Collaboration and code review using issues and pull requests &mdash; CodeRefinery mini-workshop documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../../_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=949a1ff5" />
<link rel="stylesheet" type="text/css" href="../../_static/togglebutton.css?v=13237357" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_lesson.css?v=0c089442" />
<link rel="stylesheet" type="text/css" href="../../_static/term_role_formatting.css?v=4194e21c" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_rtd_theme_ext_color_contrast.css?v=8e8ea19f" />
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=791bfbd6" />
<link rel="stylesheet" type="text/css" href="../../_static/tabs.css?v=a5c4661c" />


<link rel="shortcut icon" href="../../_static/coderefinery.ico"/>
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=187304be"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=582ca9e2"></script>
<script src="../../_static/minipres.js?v=a0d29692"></script>
<script>let toggleHintShow = 'Click to show';</script>
<script>let toggleHintHide = 'Click to hide';</script>
<script>let toggleOpenOnPrint = 'true';</script>
<script src="../../_static/togglebutton.js?v=4a39c7ea"></script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script>var togglebuttonSelector = '.toggle, .admonition.dropdown';</script>
<script data-domain="coderefinery.github.io" defer="defer" src="https://plausible.cs.aalto.fi/js/script.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex/" />
<link rel="search" title="Search" href="../../search/" />
<link rel="next" title="How to turn your project to a Git repo and share it" href="../sharing/" />
<link rel="prev" title="Copy and browse an existing project" href="../browse/" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../" class="icon icon-home">
CodeRefinery mini-workshop
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Session 1: Tracking changes</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../motivation/">Motivation for version control</a></li>
<li class="toctree-l1"><a class="reference internal" href="../browse/">Copy and browse an existing project</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Collaboration and code review using issues and pull requests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../sharing/">How to turn your project to a Git repo and share it</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Session 2: Usability</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../2/documentation/">Code documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../2/testing/">Automated testing: from unit tests to end-to-end tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../2/structure/">How to structure the code as it grows</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Session 3: Sharing</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../3/reproducibility/">Reproducible dependencies, environments, and workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../3/software-licensing/">Choosing a software license</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../3/publishing/">How to publish your code</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../guide/">Guide for instructors and contributors</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/lessons/core/">All lessons</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/">CodeRefinery</a></li>
<li class="toctree-l1"><a class="reference external" href="https://coderefinery.org/lessons/reusing/">Reusing</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../">CodeRefinery mini-workshop</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Collaboration and code review using issues and pull requests</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/coderefinery/mini-workshop/blob/main/content/1/code-review.md" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="collaboration-and-code-review-using-issues-and-pull-requests">
<h1>Collaboration and code review using issues and pull requests<a class="headerlink" href="#collaboration-and-code-review-using-issues-and-pull-requests" title="Link to this heading"></a></h1>
<div class="admonition-objectives objectives admonition" id="objectives-0">
<p class="admonition-title">Objectives</p>
<ul class="simple">
<li><p>We create an issue.</p></li>
<li><p>We open a pull request referencing the issue.</p></li>
<li><p>Together we review and discuss one or few pull request(s).</p></li>
</ul>
</div>
<p>(work in progress on creating screenshots and commentary)</p>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../browse/" class="btn btn-neutral float-left" title="Copy and browse an existing project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../sharing/" class="btn btn-neutral float-right" title="How to turn your project to a Git repo and share it" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright CodeRefinery team.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit f2d64f5

Please sign in to comment.