Skip to content

Commit

Permalink
Merge pull request #10 from UI-Research/landing-page-updates
Browse files Browse the repository at this point in the history
Landing page updates
  • Loading branch information
erika-tyagi authored Sep 12, 2023
2 parents cf1ba3e + e3f670a commit 729dd7c
Show file tree
Hide file tree
Showing 15 changed files with 222 additions and 162 deletions.
12 changes: 4 additions & 8 deletions docs/git-faqs.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.433">
<meta name="generator" content="quarto-1.3.324">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2023-07-27">
<meta name="dcterms.date" content="2023-09-12">

<title>Reproducibility at Urban - Git and Github FAQs</title>
<style>
Expand Down Expand Up @@ -56,8 +56,7 @@
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
"search-submit-button-title": "Submit"
}
}</script>

Expand Down Expand Up @@ -147,7 +146,7 @@ <h1 class="title">Git and Github FAQs</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 27, 2023</p>
<p class="date">September 12, 2023</p>
</div>
</div>

Expand Down Expand Up @@ -176,8 +175,6 @@ <h2 data-number="1" class="anchored" data-anchor-id="faqs"><span class="header-s
In general, you should follow the <a href="https://en.wikipedia.org/wiki/Principle_of_least_privilege" target="_blank">principle of least privilege</a>, which means that you should give folks the minimum level of access they need, but no more than that. In most cases, this will be the <strong>Write</strong> role, but you should refer to GitHub’s <a href="https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization" target="_blank">guide</a> describing the different roles and what they allow. If you need elevated permissions for a repository, post a message in the <a href="https://theurbaninstitute.slack.com/archives/C6J9AALDR" target="_blank">#github Slack channel</a>.</p></li>
<li><p><strong>Are there other commands that can be helpful when using Git from the command line?</strong><br>
Definitely! Learning a few simple Bash commands can be helpful for navigating the command line. A few common commands include <code>pwd</code> (to print your current directory), <code>cd</code> (to change directories), and <code>ls</code> (to list the files in a directory). For an introduction to these commands and others, we recommend <a href="https://friendly-101.readthedocs.io/en/latest/commandline.html" target="_blank">this guide</a> from Friendly Django or <a href="https://happygitwithr.com/shell.html" target="_blank">this guide</a> from Happy Git with R.</p></li>
<li><p><strong>Where did the cute images in this guide come from?</strong><br>
Those are GitHub’s mascot, the Octocat. You can read more about the history of Octocats <a href="https://cameronmcefee.com/work/the-octocat/" target="_blank">here</a> and check out the full set of Octocats that GitHub has created <a href="https://octodex.github.com/" target="_blank">here</a>.</p></li>
</ul>
</section>
<section id="additional-resources" class="level2" data-number="2">
Expand All @@ -187,7 +184,6 @@ <h2 data-number="2" class="anchored" data-anchor-id="additional-resources"><span
<li><a href="https://happygitwithr.com/" target="_blank">Happy Git and GitHub for the UserR</a></li>
<li><a href="https://www.amazon.com/Git-Pocket-Guide-Working-Introduction/dp/1449325866" target="_blank">Git Pocket Guide</a></li>
<li><a href="https://www.atlassian.com/git" target="_blank">Getting Git Right</a></li>
<li><a href="https://skills.github.com/" target="_blank">GitHub Skills</a></li>
<li><a href="https://speakerdeck.com/alicebartlett/git-for-humans" target="_blank">Git for Humans</a></li>
</ul>

Expand Down
9 changes: 4 additions & 5 deletions docs/git-installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.433">
<meta name="generator" content="quarto-1.3.324">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2023-07-27">
<meta name="dcterms.date" content="2023-09-12">

<title>Reproducibility at Urban - Git and GitHub Access and Installation</title>
<style>
Expand Down Expand Up @@ -90,8 +90,7 @@
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
"search-submit-button-title": "Submit"
}
}</script>

Expand Down Expand Up @@ -188,7 +187,7 @@ <h1 class="title">Git and GitHub Access and Installation</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 27, 2023</p>
<p class="date">September 12, 2023</p>
</div>
</div>

Expand Down
21 changes: 10 additions & 11 deletions docs/git-workflow.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.3.433">
<meta name="generator" content="quarto-1.3.324">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="dcterms.date" content="2023-07-27">
<meta name="dcterms.date" content="2023-09-12">

<title>Reproducibility at Urban - Git and Github Workflow</title>
<style>
Expand Down Expand Up @@ -90,8 +90,7 @@
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
"search-submit-button-title": "Submit"
}
}</script>

Expand Down Expand Up @@ -195,7 +194,7 @@ <h1 class="title">Git and Github Workflow</h1>
<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">July 27, 2023</p>
<p class="date">September 12, 2023</p>
</div>
</div>

Expand Down Expand Up @@ -229,7 +228,7 @@ <h3 data-number="2.1" class="anchored" data-anchor-id="the-big-picture"><span cl
</ol>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-workflow-v2.png" class="img-fluid" width="1350"></p>
<p><img src="images/git-workflow-v2.png" class="img-fluid"></p>
</div>
</div>
</section>
Expand Down Expand Up @@ -279,7 +278,7 @@ <h3 data-number="2.3" class="anchored" data-anchor-id="cloning-an-existing-repos
<div class="sourceCode" id="cb5"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone <span class="op">&lt;</span>remote_url_for_your_repo<span class="op">&gt;</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-workflow-commands-v2.png" class="img-fluid" width="925"></p>
<p><img src="images/git-workflow-commands-v2.png" class="img-fluid"></p>
</div>
</div>
</section>
Expand All @@ -302,7 +301,7 @@ <h3 data-number="2.5" class="anchored" data-anchor-id="basic-commands-and-workfl
<p>Before running the <code>git push</code> command, your code and commits could only be accessed on your local computer.</p>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-github-workflow-v2.png" class="img-fluid" width="924"></p>
<p><img src="images/git-github-workflow-v2.png" class="img-fluid"></p>
</div>
</div>
</section>
Expand All @@ -314,15 +313,15 @@ <h2 data-number="3" class="anchored" data-anchor-id="collaborative-workflow"><sp
<div class="sourceCode" id="cb10"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> pull origin main</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-workflow-collab.png" class="img-fluid" width="925"></p>
<p><img src="images/git-workflow-collab.png" class="img-fluid"></p>
</div>
</div>
<section id="branches" class="level3" data-number="3.1">
<h3 data-number="3.1" class="anchored" data-anchor-id="branches"><span class="header-section-number">3.1</span> Branches</h3>
<p>So far in this guide, we’ve been working off a single <code>main</code> branch. By using multiple branches, you and your collaborators can update existing code or add new code without the fear of overwriting each others’ files. Branches let you say “Hey, I’m going to leave the main version of the code alone while I try some things out over here.”</p>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-branches.png" class="img-fluid" width="1089"></p>
<p><img src="images/git-branches.png" class="img-fluid"></p>
</div>
</div>
<p><code>git checkout</code> switches your local version to different branch. The <code>-b</code> flag in the command below tells Git to first create a new branch and then switch to it. When you first create a new branch, it will be identical to the local version of the branch that you switched from (typically the <code>main</code> branch).</p>
Expand All @@ -347,7 +346,7 @@ <h3 data-number="3.2" class="anchored" data-anchor-id="pull-requests"><span clas
</ol>
<div class="cell">
<div class="cell-output-display">
<p><img src="images/git-workflow-branches.png" class="img-fluid" width="1555"></p>
<p><img src="images/git-workflow-branches.png" class="img-fluid"></p>
</div>
</div>
<p>After merging the pull request, you should return to the <code>main</code> branch and sync your local directory with the merged changes:</p>
Expand Down
Loading

0 comments on commit 729dd7c

Please sign in to comment.