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 Jan 21, 2025
1 parent 5f5c3c4 commit cdd18aa
Show file tree
Hide file tree
Showing 7 changed files with 94 additions and 23 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
37895cc5
e5169afa
4 changes: 2 additions & 2 deletions git-refresher/clone-a-repo.html
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ <h1 class="title">Cloning a repository</h1>


<hr>
<p>To work on the contents of an existing Git <a href="glossary.html#repository"><strong>repository</strong></a>, the first step will often be to <a href="glossary.html#clone"><strong>“clone”</strong></a> it to your local working environment (i.e.&nbsp;your laptop!).</p>
<p>To work on the contents of an existing Git <a href="../glossary.html#repository"><strong>repository</strong></a>, the first step will often be to <a href="../glossary.html#clone"><strong>“clone”</strong></a> it to your local working environment (i.e.&nbsp;your laptop!).</p>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
Expand All @@ -347,7 +347,7 @@ <h1 class="title">Cloning a repository</h1>
</div>
</div>
<div class="tabset-margin-container"></div><div class="panel-tabset">
<ul class="nav nav-tabs" role="tablist"><li class="nav-item" role="presentation"><a class="nav-link active" id="tabset-1-1-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true" aria-current="page">Git Bash:</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-2-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">RStudio</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-3-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-3" role="tab" aria-controls="tabset-1-3" aria-selected="false">GitHub Desktop</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-4-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-4" role="tab" aria-controls="tabset-1-4" aria-selected="false">VS Code</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-5-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-5" role="tab" aria-controls="tabset-1-5" aria-selected="false">PyCharm</a></li></ul>
<ul class="nav nav-tabs" role="tablist"><li class="nav-item" role="presentation"><a class="nav-link active" id="tabset-1-1-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-1" role="tab" aria-controls="tabset-1-1" aria-selected="true" aria-current="page">Git Bash</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-2-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-2" role="tab" aria-controls="tabset-1-2" aria-selected="false">RStudio</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-3-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-3" role="tab" aria-controls="tabset-1-3" aria-selected="false">GitHub Desktop</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-4-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-4" role="tab" aria-controls="tabset-1-4" aria-selected="false">VS Code</a></li><li class="nav-item" role="presentation"><a class="nav-link" id="tabset-1-5-tab" data-bs-toggle="tab" data-bs-target="#tabset-1-5" role="tab" aria-controls="tabset-1-5" aria-selected="false">PyCharm</a></li></ul>
<div class="tab-content">
<div id="tabset-1-1" class="tab-pane active" role="tabpanel" aria-labelledby="tabset-1-1-tab">
<p>Navigate to the folder on your device where you want to clone the repo. Right-click in the directory and select <strong>Git Bash Here</strong>.</p>
Expand Down
2 changes: 1 addition & 1 deletion git-refresher/making-a-branch.html
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ <h1 class="title">Making a new branch</h1>
</header>


<p>In a Git repository, different versions of work are controlled by using what are called “<a href="https://dfe-analytical-services.github.io/azure-devops-for-analysis/version-control-using-git---the-basics.html#making-branches">branches</a>”. Edits can be made to files on a branch and those will not effect files on any other branch.</p>
<p>In a Git <a href="../glossary.html#repository">repository</a>, different versions of work are controlled by using what are called “<a href="https://dfe-analytical-services.github.io/azure-devops-for-analysis/version-control-using-git---the-basics.html#making-branches">branches</a>”. Edits can be made to files on a branch and those will not effect files on any other branch.</p>
<p>Most repositories will have a “main” branch. This is considered the central latest working version of your work. When editing work, we generally don’t make edits directly on the main branch. Instead we create specific branches for specific chunks of work.</p>
<p>Having <a href="clone-a-repo.html">cloned the git-academy-sandbox repository</a>, now make a new branch to work in.</p>
<div class="tabset-margin-container"></div><div class="panel-tabset">
Expand Down
2 changes: 1 addition & 1 deletion git-refresher/recording-changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ <h1 class="title">Recording changes (add and commit)</h1>
</header>


<p>This section will guide you through recording changes you make to your repo.</p>
<p>This section will guide you through recording changes you make to your repo through the process of <a href="../glossary.html#add"><strong>adding</strong></a> and <a href="../glossary.html#stage"><strong>staging</strong></a> files.</p>
<p>These steps help you manage and track changes in your project, making collaboration and version control efficient and reliable.</p>
<p>Having <a href="making-a-branch.html">created your own branch</a>, follow the instructions below to make and record changes in your repo.</p>
<div class="callout callout-style-default callout-tip callout-titled">
Expand Down
43 changes: 42 additions & 1 deletion glossary.html
Original file line number Diff line number Diff line change
Expand Up @@ -272,8 +272,11 @@
<h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#clone" id="toc-clone" class="nav-link active" data-scroll-target="#clone">Clone</a></li>
<li><a href="#add" id="toc-add" class="nav-link active" data-scroll-target="#add">Add</a></li>
<li><a href="#commit" id="toc-commit" class="nav-link" data-scroll-target="#commit">Commit</a></li>
<li><a href="#clone" id="toc-clone" class="nav-link" data-scroll-target="#clone">Clone</a></li>
<li><a href="#repository" id="toc-repository" class="nav-link" data-scroll-target="#repository">Repository</a></li>
<li><a href="#stage" id="toc-stage" class="nav-link" data-scroll-target="#stage">Stage</a></li>
</ul>
<div class="toc-actions"><ul><li><a href="https://github.com/dfe-analytical-services/git-academy/edit/main/glossary.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/dfe-analytical-services/git-academy/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
</div>
Expand All @@ -300,13 +303,51 @@ <h1 class="title">Glossary</h1>


<hr>
<section id="add" class="level2">
<h2 class="anchored" data-anchor-id="add">Add</h2>
<p>Adding is the process of identifying to Git which files you would like to include in a given <a href="glossary.html#commit">commit</a>.</p>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Tip
</div>
</div>
<div class="callout-body-container callout-body">
<p>Add and stage are synonymous</p>
</div>
</div>
</section>
<section id="commit" class="level2">
<h2 class="anchored" data-anchor-id="commit">Commit</h2>
<p>Committing is where you record changes in the Git history. This is one of the most important aspects to understand when using Git. A commit provides a single point in the version control history and when navigating back through the history, you can only navigate to changes that are part of a commit.</p>
</section>
<section id="clone" class="level2">
<h2 class="anchored" data-anchor-id="clone">Clone</h2>
<p>Cloning a repository is the process of creating a copy of a repository folder system on your local working environment (e.g.&nbsp;your laptop computer).</p>
</section>
<section id="repository" class="level2">
<h2 class="anchored" data-anchor-id="repository">Repository</h2>
<p>A repository (or repo) is effectively a project folder. A given repostory would usually contain all the work for a specific project (e.g.&nbsp;a data pipeline, an R-Shiny app, etc).</p>
</section>
<section id="stage" class="level2">
<h2 class="anchored" data-anchor-id="stage">Stage</h2>
<p>Staging is the process of identifying to Git which files you would like to include in a given <a href="glossary.html#commit">commit</a>.</p>
<div class="callout callout-style-default callout-tip callout-titled">
<div class="callout-header d-flex align-content-center">
<div class="callout-icon-container">
<i class="callout-icon"></i>
</div>
<div class="callout-title-container flex-fill">
Tip
</div>
</div>
<div class="callout-body-container callout-body">
<p>Add and stage are synonymous</p>
</div>
</div>


</section>
Expand Down
34 changes: 32 additions & 2 deletions search.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
"href": "git-refresher/recording-changes.html",
"title": "Recording changes (add and commit)",
"section": "",
"text": "This section will guide you through recording changes you make to your repo.\nThese steps help you manage and track changes in your project, making collaboration and version control efficient and reliable.\nHaving created your own branch, follow the instructions below to make and record changes in your repo.\n\n\n\n\n\n\nEdit your git-academy-log file\n\n\n\n\nPut an x inside the brackets for the “Clone git-academy-sandbox” and “Create a new branch in GitHub (&lt;github_username&gt;/main)”.\nSave the file.\n\n\n\n\nGit BashRStudioGitHub DesktopVS CodePyCharm\n\n\n\nCheck which files have changed by entering this command in Git Bash:\ngit status\nStage the changes you want to commit by using one of the commands below.\n\nTo add changes to one file at a time:\ngit add git-academy-log.md\n\nOR\n\nTo add all changes:\ngit add .\n\nCommit changes with a message by entering:\ngit commit -m \"Checked clone sandbox and make new branch tasks\"\n\n\n\n\nIn the Git panel of RStudio (see image below), tick the files you want to record the changes for.\nClick the commit button. It has a tick mark on two sheets of paper.\n\n\n\nWrite a short message to describe the changes you made.\nClick “Commit”.\n\n\nNote that you can see the changes made by comparing the green (current version) and the red (old version) highlighted sections.\n\n\n\n\n\n\n\n\n\nClick on the branches drop down menu at the top of the screen and click “Commit”.\n\nOR\n\nClick on the symbol that shows a circle flanked by two lines in the sidebar as shown in the image below.\n\n\n\nIn the “Commit” pop up window, tick the files you wish to record changes for if they’re not already ticked.\nWrite a short message to describe the changes you made.\nClick “Commit”.\n\n\n\n\n\n\n\n\n Back to top",
"text": "This section will guide you through recording changes you make to your repo through the process of adding and staging files.\nThese steps help you manage and track changes in your project, making collaboration and version control efficient and reliable.\nHaving created your own branch, follow the instructions below to make and record changes in your repo.\n\n\n\n\n\n\nEdit your git-academy-log file\n\n\n\n\nPut an x inside the brackets for the “Clone git-academy-sandbox” and “Create a new branch in GitHub (&lt;github_username&gt;/main)”.\nSave the file.\n\n\n\n\nGit BashRStudioGitHub DesktopVS CodePyCharm\n\n\n\nCheck which files have changed by entering this command in Git Bash:\ngit status\nStage the changes you want to commit by using one of the commands below.\n\nTo add changes to one file at a time:\ngit add git-academy-log.md\n\nOR\n\nTo add all changes:\ngit add .\n\nCommit changes with a message by entering:\ngit commit -m \"Checked clone sandbox and make new branch tasks\"\n\n\n\n\nIn the Git panel of RStudio (see image below), tick the files you want to record the changes for.\nClick the commit button. It has a tick mark on two sheets of paper.\n\n\n\nWrite a short message to describe the changes you made.\nClick “Commit”.\n\n\nNote that you can see the changes made by comparing the green (current version) and the red (old version) highlighted sections.\n\n\n\n\n\n\n\n\n\nClick on the branches drop down menu at the top of the screen and click “Commit”.\n\nOR\n\nClick on the symbol that shows a circle flanked by two lines in the sidebar as shown in the image below.\n\n\n\nIn the “Commit” pop up window, tick the files you wish to record changes for if they’re not already ticked.\nWrite a short message to describe the changes you made.\nClick “Commit”.\n\n\n\n\n\n\n\n\n Back to top",
"crumbs": [
"Git basics refresher",
"Recording changes (add and commit)"
Expand All @@ -98,7 +98,7 @@
"href": "git-refresher/clone-a-repo.html",
"title": "Cloning a repository",
"section": "",
"text": "To work on the contents of an existing Git repository, the first step will often be to “clone” it to your local working environment (i.e. your laptop!).\n\n\n\n\n\n\nGetting the clone URL\n\n\n\nTo clone a repo, you’ll first need to find the necessary URL.\n\nGo to the git-academy-sandbox repository page on GitHub.\nClick the “Code” button and copy the URL (HTTPS link).\n\n\n\n\nGit Bash:RStudioGitHub DesktopVS CodePyCharm\n\n\nNavigate to the folder on your device where you want to clone the repo. Right-click in the directory and select Git Bash Here.\n{width=“60%”, fig-align=“center”}\n\nIn the Git Bash window that opens, use the `git clone` command followed by the URL you copied from GitHub. For this repo, we would enter:\n\ngit clone https://github.com/dfe-analytical-services/git-academy-sandbox.git\nYou will need to right-click to paste, as the keyboard shortcut will not work in Git Bash and then press enter.\n\nNavigate into the repo by typing cd git-academy-sandbox and pressing enter.\nYou should now see the current branch name (e.g. main) at the end of the file path as below:\n\n\n\n\n\n\n\nType git log and press enter to view recent commits. Press q when you are ready to exit git log.\nType git status and press enter to check the state of the cloned repository (at this point, it should say everything is up to date, as you haven’t made any changes yet).\n\n\n\n\nIn RStudio, go to File &gt; New Project &gt; Version Control &gt; Git.\nPaste the URL you copied from GitHub into the “Repository URL” field.\nChoose a directory on your device where you want to save the repo.\nClick “Create Project”.\n\n{width=“60%”, fig-align=“center”}\nCheck the Files pane in RStudio to see if the repo files have been cloned to your local machine. The files pane normally opens in the right-hand bottom corner of RStudio.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n Back to top",
"text": "To work on the contents of an existing Git repository, the first step will often be to “clone” it to your local working environment (i.e. your laptop!).\n\n\n\n\n\n\nGetting the clone URL\n\n\n\nTo clone a repo, you’ll first need to find the necessary URL.\n\nGo to the git-academy-sandbox repository page on GitHub.\nClick the “Code” button and copy the URL (HTTPS link).\n\n\n\n\nGit BashRStudioGitHub DesktopVS CodePyCharm\n\n\nNavigate to the folder on your device where you want to clone the repo. Right-click in the directory and select Git Bash Here.\n{width=“60%”, fig-align=“center”}\n\nIn the Git Bash window that opens, use the `git clone` command followed by the URL you copied from GitHub. For this repo, we would enter:\n\ngit clone https://github.com/dfe-analytical-services/git-academy-sandbox.git\nYou will need to right-click to paste, as the keyboard shortcut will not work in Git Bash and then press enter.\n\nNavigate into the repo by typing cd git-academy-sandbox and pressing enter.\nYou should now see the current branch name (e.g. main) at the end of the file path as below:\n\n\n\n\n\n\n\nType git log and press enter to view recent commits. Press q when you are ready to exit git log.\nType git status and press enter to check the state of the cloned repository (at this point, it should say everything is up to date, as you haven’t made any changes yet).\n\n\n\n\nIn RStudio, go to File &gt; New Project &gt; Version Control &gt; Git.\nPaste the URL you copied from GitHub into the “Repository URL” field.\nChoose a directory on your device where you want to save the repo.\nClick “Create Project”.\n\n{width=“60%”, fig-align=“center”}\nCheck the Files pane in RStudio to see if the repo files have been cloned to your local machine. The files pane normally opens in the right-hand bottom corner of RStudio.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n Back to top",
"crumbs": [
"Git basics refresher",
"Cloning a repository"
Expand All @@ -125,6 +125,26 @@
"section": "",
"text": "Back to top"
},
{
"objectID": "glossary.html#add",
"href": "glossary.html#add",
"title": "Glossary",
"section": "Add",
"text": "Add\nAdding is the process of identifying to Git which files you would like to include in a given commit.\n\n\n\n\n\n\nTip\n\n\n\nAdd and stage are synonymous",
"crumbs": [
"Glossary"
]
},
{
"objectID": "glossary.html#commit",
"href": "glossary.html#commit",
"title": "Glossary",
"section": "Commit",
"text": "Commit\nCommitting is where you record changes in the Git history. This is one of the most important aspects to understand when using Git. A commit provides a single point in the version control history and when navigating back through the history, you can only navigate to changes that are part of a commit.",
"crumbs": [
"Glossary"
]
},
{
"objectID": "glossary.html#clone",
"href": "glossary.html#clone",
Expand All @@ -145,6 +165,16 @@
"Glossary"
]
},
{
"objectID": "glossary.html#stage",
"href": "glossary.html#stage",
"title": "Glossary",
"section": "Stage",
"text": "Stage\nStaging is the process of identifying to Git which files you would like to include in a given commit.\n\n\n\n\n\n\nTip\n\n\n\nAdd and stage are synonymous",
"crumbs": [
"Glossary"
]
},
{
"objectID": "git-refresher/moving-between-branches.html",
"href": "git-refresher/moving-between-branches.html",
Expand Down
Loading

0 comments on commit cdd18aa

Please sign in to comment.