Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/build-hugo.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Build site with Hugo

on:
push:
pull_request:
workflow_dispatch:

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6

- name: Set up Hugo
uses: peaceiris/actions-hugo@75d2e84710de30f6ff7268e08f310b60ef14033f # v3, pinned for security
with:
hugo-version: '0.160.1'
extended: true

- name: Build site with Hugo
run: |
hugo --minify

- name: Upload artifacts
uses: actions/upload-artifact@v7
with:
name: hugo-public
path: public/*
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![](https://i.creativecommons.org/l/by/3.0/80x15.png)](https://creativecommons.org/licenses/by/4.0/)
<!-- badges: end -->

This repo contains the source code of the website of the ***Git & Github through GitKraken Client - From Zero to Hero!*** course.
This repo contains the source code of the website of the ***Git & GitHub through GitKraken Client - From Zero to Hero!*** course.

## Prepation for course:

Expand Down Expand Up @@ -76,15 +76,15 @@ Start building sites …
hugo v0.123.7+extended linux/amd64 BuildDate=2025-07-18T03:41:49Z VendorInfo=ubuntu:0.123.7-1ubuntu0.3


| EN
| EN
-------------------+------
Pages | 72
Paginator pages | 0
Non-page files | 0
Static files | 395
Processed images | 0
Aliases | 0
Cleaned | 0
Pages | 72
Paginator pages | 0
Non-page files | 0
Static files | 395
Processed images | 0
Aliases | 0
Cleaned | 0

Built in 343 ms
Environment: "development"
Expand Down Expand Up @@ -112,7 +112,9 @@ Also, because slides are in the content, they are indexed by the Hugo learn them

## Credits

The workshop materials website template is based on the
The workshop materials website template was originally based on the
[hugo-theme-learn](https://github.com/matcornic/hugo-theme-learn), [reveal-hugo](https://github.com/dzello/reveal-hugo)
Hugo themes and further work and configuration by Maëlle Salmon for her course site on [**Scientific blogging with R
Markdown**](https://github.com/maelle/rmd-blogging-course).

The current version uses [hugo-theme-relearn](https://github.com/McShelby/hugo-theme-relearn).
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
10 changes: 7 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ignoreFiles = ["\\.Rmd$", "\\.Rmarkdown$", "_files$", "_cache$", "index\\.html",

[module]
[[module.imports]]
path = "github.com/matcornic/hugo-theme-learn"
path = "github.com/McShelby/hugo-theme-relearn"
[[module.imports]]
path = "github.com/dzello/reveal-hugo"

Expand Down Expand Up @@ -55,13 +55,17 @@ weight = 50

[params]
editURL = "https://github.com/RSE-Sheffield/git-github-zero-to-hero/edit/master/content/"
description = "Git & Github through GitKraken Client - From Zero to Hero!"
author = "Anna Krystalli, Sheffield RSE"
showVisitedLinks = true
disableBreadcrumb = false
disableNextPrev = false
themeVariant = "rse-learn"
linkTitle = " "

[params.author]
name = "Anna Krystalli, Sheffield RSE"

[params.logo]
src = "/images/TUOS-RSE-logos-small.png"


[markup]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Github
title: GitHub
weight: 3
---

Expand Down
4 changes: 2 additions & 2 deletions content/00-intro-to-version-control/04a-anatomy-repo.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ weight: 5
- **License**. Without some sort of licence, the contents of the repository are technically closed. Some allow users of the code to do anything they like with their code - these are known as permissive licences. Examples are the [MIT Licence](https://tldrlegal.com/license/mit-license) or [Apache](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)).
+ [https://choosealicense.com/](https://choosealicense.com/) - does what it says on the tin and helps you choose a licence. Here are some resources to help you choose:
+ [https://tldrlegal.com/](https://tldrlegal.com/) - plain english explanations of licences in bullet form.

- **Contributing guide** - make a file called CONTRIBUTING.md and guidelines for contributors so they know what they should do if they want to help you out.

- **Code of Conduct** - good projects have codes of conduct to make sure that people are treated well. Github has an [Code of Conduct wizard](https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/) to make it easy to add one.
- **Code of Conduct** - good projects have codes of conduct to make sure that people are treated well. GitHub has an [Code of Conduct wizard](https://help.github.com/articles/adding-a-code-of-conduct-to-your-project/) to make it easy to add one.

- **Issues** - use GitHub issues to record and discuss tasks.

Expand Down
6 changes: 3 additions & 3 deletions content/00-intro-to-version-control/05-recap.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ weight: 5

<br>

> Git, GitKraken Client, and Github are three separate things. Git is the system used for version control, but you don't have to use it with GitHub or GitKraken Client.
> Git, GitKraken Client, and GitHub are three separate things. Git is the system used for version control, but you don't have to use it with GitHub or GitKraken Client.

<br>

#### - **Git** allows you to effectively "save" your work at important points in time and come back to any of the save points.
#### - Sharing our work on GitHub allows others to inspect our work, make copies and contribute back changes.

#### - Sharing our work on GitHub allows others to inspect our work, make copies and contribute back changes.

#### - GitKraken Client allows you to work with both from a single graphical user interface.

Expand Down
5 changes: 0 additions & 5 deletions content/00-intro-to-version-control/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,3 @@ pre: <b>00. </b>
title: Introduction to Version Control
weight: 1
---


# Introduction to Version Control


3 changes: 1 addition & 2 deletions content/01-getting-started-with-git-and-github/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
chapter: true
date: "2020-08-05T17:40:37+01:00"
pre: <b>01. </b>
title: Getting Started With Git and Github
title: Getting Started With Git and GitHub
weight: 2
---
# Getting Started With Git and Github

### Let's start with some practical exercises!

Expand Down
8 changes: 3 additions & 5 deletions content/02-websites-with-github-pages/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,12 @@
chapter: true
date: "2020-08-05T17:55:45+01:00"
pre: <b>02. </b>
title: Websites With Github Pages
title: Websites With GitHub Pages
weight: 3
---

# Websites With Github Pages
Still not convinced that GitHub is something you should be using? There's another great feature:

Still not convinced that GitHub is something you should be using? There's another great feature:

**They make it relatively straightforward to create a website for free**, using [markdown](https://help.github.com/categories/writing-on-github/) and [GitHub pages](https://pages.github.com/).
**They make it relatively straightforward to create a website for free**, using [markdown](https://help.github.com/categories/writing-on-github/) and [GitHub pages](https://pages.github.com/).


3 changes: 1 addition & 2 deletions content/03-collaborative_github_basics/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
chapter: true
date: "2020-08-05T17:55:45+01:00"
pre: <b>03. </b>
title: Cloning and Collaborating with GitKraken Client
weight: 4
---

# Cloning and Collaborating

In this Chapter we'll be exploring how to **clone** (copy) other people's repositories from GitHub and contribute content back as well as how to sync local repositories with upstream changes.
2 changes: 1 addition & 1 deletion content/04-collaborative_github_advanced/00-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We'll be:



## Github Workflow
## GitHub Workflow



Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
+++
title = "Resolve Issues in Branches"
date = 2021-05-13T17:58:45+03:00
date = 2021-05-13T17:58:45+03:00
weight = 3
+++



A **powerful tool for keeping track of tasks, enhancements, and bugs for your projects is the issues** feature of GitHub. You can access the issues associated with a repository through the <i class="fas fa-exclamation-circle"></i> **Issues** tab.

They allow **storing conversations about tasks in the project repository**, visible to the whole team throughout the life cycle of the project, rather that them being buried in hard to navigate email chains! 💯
They allow **storing conversations about tasks in the project repository**, visible to the whole team throughout the life cycle of the project, rather that them being buried in hard to navigate email chains! 💯

It's also **easy to see the status of tasks** as issues can be closed when completed, leaving the tasks still pending visible by default.

Expand Down Expand Up @@ -40,15 +40,15 @@ For more information, check out [Configuring issue templates for your repository

### <i class="fas fa-user-circle"></i> Open issue from templates

To create a new issue navigate to the <i class="fas fa-exclamation-circle"></i> **Issues** tab
To create a new issue navigate to the <i class="fas fa-exclamation-circle"></i> **Issues** tab

{{< figure src="/images/ag-issues-tab.png" >}}

Click {{% button href="" %}} **New issue** {{% /button %}}
Click {{% button href="" %}} **New issue** {{% /button %}}

{{< figure src="/images/ag-issue-init.png" >}}

Because we are using GitHub Issue templates, we are immediatelly presented with the 3 issue templates I've created.
Because we are using GitHub Issue templates, we are immediatelly presented with the 3 issue templates I've created.

To demonstrate, I'm going to open the **Add subtraction function** issue. To initiate the process, I click on {{% button href="" %}} **Get started** {{% /button %}} next to the issue template I want to open.

Expand All @@ -67,15 +67,15 @@ The **special `-[ ]` list notation** means the **checkboxes will be interactive*
When we're creating our issue, the main body contains two tabs:

- **Write:** were you enter the contents of the issue in markdown
- **Preview:** were you can preview what the content will look like when it is rendered once the issue is submited.
- **Preview:** were you can preview what the content will look like when it is rendered once the issue is submited.

Toggle the tabs below to explore this feature. Note how the checklist is rendered in the Preview tab.

{{< tabs groupId="issues" >}}
{{% tab name="Write" %}}
{{< tabs groupid="issues" >}}
{{% tab title="Write" %}}
{{< figure src="/images/ag-issue-sub.png" >}}
{{% /tab %}}
{{% tab name="Preview" %}}
{{% tab title="Preview" %}}
{{< figure src="/images/ag-issue-sub-preview.png" >}}
{{% /tab %}}
{{% /tabs %}}
Expand All @@ -93,15 +93,15 @@ To do this, I click on **Assignees** on the top-right which launches a drop-down

{{% notice tip %}}

You can **assign an issue to a team mate, add more or remove assignees at any point**, even after you've opened the issue. If your repo is public, **you can also assign issues to users who are not collaborators** on your repo. Just type in their username in the drop down menu textbox.
You can **assign an issue to a team mate, add more or remove assignees at any point**, even after you've opened the issue. If your repo is public, **you can also assign issues to users who are not collaborators** on your repo. Just type in their username in the drop down menu textbox.

{{% /notice %}}

### <i class="fas fa-user-circle"></i> Submit issue

Once I've assigned the issue to a team mate, I click {{% button href="" %}} **Submit new issue** {{% /button %}} to create it.

The issue has now been **opened** and given a unique number (in this case #2).
The issue has now been **opened** and given a unique number (in this case #2).

{{< figure src="/images/ag-issue-sub-cmpl.png" >}}

Expand All @@ -118,7 +118,7 @@ The issue is also now listed under the <i class="fas fa-exclamation-circle"></i>

{{% notice warning %}}

Make sure you have <strong>opened and assigned a unique issue to each member</strong> of your team!
Make sure you have <strong>opened and assigned a unique issue to each member</strong> of your team!

{{% /notice %}}

Expand Down Expand Up @@ -159,7 +159,7 @@ Start by clicking the {{% button href="" %}} **Branch** <br> **<i class="fas fa-

{{< figure src="/images/ag-sub-branch-init.png" >}}

The **`subtract` branch has now been created and been checked out** (indicated by the fact that the the **<i class="fas fa-check-square" style="color:#7CFF7E; background-color:black; padding:2px"></i> <i class="fas fa-code-branch"></i> subtract** branch in the **<i class="fas fa-laptop"></i> local** repository is now checked).
The **`subtract` branch has now been created and been checked out** (indicated by the fact that the the **<i class="fas fa-check-square" style="color:#7CFF7E; background-color:black; padding:2px"></i> <i class="fas fa-code-branch"></i> subtract** branch in the **<i class="fas fa-laptop"></i> local** repository is now checked).

{{< figure src="/images/ag-sub-branch.png" >}}

Expand All @@ -169,7 +169,7 @@ The next step in Bob's instructions is to create a new `subtract.py` file in the

A nice feature of GitKraken Client is that, as well as a basic text editor, it also **allows us to create new files!**

To create a new file, **first launch GitKraken Client's Command Palette** with
To create a new file, **first launch GitKraken Client's Command Palette** with
<img src="/images/command-symbol.png" width="2px" style="align:left; display:inline; margin:0;"/> **| Ctrl + P**

Next, type **File**. This launches a dropdown menu of action you can perform on files. Select **Create file**.
Expand Down Expand Up @@ -241,7 +241,7 @@ Once the file is open for editing, **add the import line of code from your issue

The next step in Bob's instructions is to create a new `test_subtract.py` file in the `tests/` directory and paste the code for the `subtract` function test.

To create the new file, **launch GitKraken Client's Command Palette** again with
To create the new file, **launch GitKraken Client's Command Palette** again with
<img src="/images/command-symbol.png" width="2px" style="align:left; display:inline; margin:0;"/> **| Ctrl + P**

Next, type **File** to launches the file action dropdown menu. Select **Create file** and **type in the path to the new file you want to create**, In Bob's case it's `tests/test_subtract.py` and hit **Enter|Return**.
Expand Down
17 changes: 7 additions & 10 deletions content/04-collaborative_github_advanced/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
+++
title = "Advanced Collaboration through Github"
date = 2021-05-13T17:25:55+03:00
weight = 5
chapter = true
pre = "<b>04. </b>"
+++


# Advanced Collaboration through Github
---
chapter: true
date: "2021-05-13T17:25:55+03:00"
pre: "<b>04. </b>"
title: "Advanced Collaboration through GitHub"
weight: 5
---

In this chapter we will learn how to set up a GitHub repo for team collaboration, add collaborators, use issues to administer tasks, contribute code through branches, review contributions and handle merge conflicts.
4 changes: 1 addition & 3 deletions content/_index.en.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: "Git & Github through GitKraken Client - From Zero to Hero! "
title: "Git & GitHub through GitKraken Client - From Zero to Hero!"
---

# Git & Github through GitKraken Client - From Zero to Hero!

In this course you'll be learning version control and collaboration through Git, GitHub & GitKraken Client

* Version controlling your own project through Git & GitHub.
Expand Down
5 changes: 4 additions & 1 deletion content/credits.en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
date: "2020-08-05T14:40:58+01:00"
title: Credits
weight: 5
weight: 100
hidden: true
chapter: false
disableToc: false
---

## Content
Expand Down
2 changes: 1 addition & 1 deletion content/faq-glossary-links/01-faq.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ as unit, integration and regression tests, linting of code to ensure it complies
releasing packages. This, along with careful code review of Pull Requests, helps ensure that newly submitted code does
not break software.

### Does Github not have a staging area?
### Does GitHub not have a staging area?

Not when making edits directly to a single file online via GitHub as typically you are only changing a single file so
there is no need to choose which files to stage. However, rather than committing them directly to the branch you are
Expand Down
3 changes: 0 additions & 3 deletions content/faq-glossary-links/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,3 @@ pre: <b><i class="fa fa-question-circle" aria-hidden="true"></i> </b>
title: FAQ, Glossary and Links
weight: 6
---


# FAQ, Glossary and Links
5 changes: 4 additions & 1 deletion content/platforms.en.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
---
date: "2022-10-31T09:47:00+01:00"
title: Online Learning Platforms
weight: 5
weight: 100
hidden: true
chapter: false
disableToc: false
---

This page is for keeping some useful resources in running this course online.
Expand Down
2 changes: 1 addition & 1 deletion content/setup/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Setup
weight: 100
weight: 7
chapter: true
pre: <i class="fas fa-cogs"></i>&nbsp;
menuTitle: Setup
Expand Down
Loading