|
| 1 | +--- |
| 2 | +title: "Introduction to GitHub" |
| 3 | +subtitle: "Tværs Gruppemøde, April 2025" |
| 4 | +author: "Signe Kirk Brødbæk" |
| 5 | +format: |
| 6 | + revealjs: |
| 7 | + theme: default |
| 8 | + slide-number: true |
| 9 | + from: markdown+emoji |
| 10 | + logo: /_extensions/seedcase-project/seedcase-theme/logos/navbar-logo-seedcase-project.svg |
| 11 | + footer: "Tværs Gruppemøde, April 2025" |
| 12 | +exclude-from-listing: true |
| 13 | +--- |
| 14 | + |
| 15 | +## Agenda |
| 16 | + |
| 17 | +1. Who am I? |
| 18 | +2. What is GitHub? |
| 19 | +3. What can it be used for? |
| 20 | +4. Why use GitHub? |
| 21 | +5. Examples :eyes: |
| 22 | +6. GitHub workshop, May 26 |
| 23 | + |
| 24 | +::: notes |
| 25 | +Aim: *Brief* introduction to GitHub and how it can be useful for |
| 26 | +projects within SDCA |
| 27 | + |
| 28 | +Questions: This is a new topic for many and there *can* be some |
| 29 | +GitHub-related lingo. I will try to explain everything as we go along, |
| 30 | +but if you have questions, don't hesitate to ask. |
| 31 | +::: |
| 32 | + |
| 33 | +## Who am I? |
| 34 | + |
| 35 | +- Primarily working on the Seedcase Project |
| 36 | +- Develop teaching material and teach workshops |
| 37 | +- R-package: Open-Source Diabetes Classifier |
| 38 | +- Admin for `steno-aarhus` on GitHub |
| 39 | + |
| 40 | +::: notes |
| 41 | +- Seedcase Project: open source software (Python packages) for |
| 42 | + packaging and documenting research data |
| 43 | +::: |
| 44 | + |
| 45 | +. . . |
| 46 | + |
| 47 | +I spend 95 % of my work time using GitHub :raised_hands: |
| 48 | + |
| 49 | +## What is GitHub? |
| 50 | + |
| 51 | +::::: columns |
| 52 | +::: {.column width="70%"} |
| 53 | +- A website: [github.com](https://github.com) |
| 54 | +- Stores files in *repositories* |
| 55 | +- Uses version control (*Git*) to track file changes |
| 56 | + - *Git* + *Hub* |
| 57 | +::: |
| 58 | + |
| 59 | +::: {.column width="30%"} |
| 60 | +{width="70%"} |
| 61 | +{width="70%"} |
| 62 | +::: |
| 63 | +::::: |
| 64 | + |
| 65 | +::: notes |
| 66 | +- Website: At its core, it's a website. If you open up your browser |
| 67 | + and type in "GitHub.com", you will be taken to GitHub |
| 68 | +- Stores files: GitHub is a place where you can store and share files |
| 69 | + related to a project, like a website, in a "repository" (meaning "storage" or "place to keep things", in Danish: "opbevare"). |
| 70 | + - A repository is like a folder on your computer, but instead of being on your |
| 71 | + computer, it's on the internet. You can access it from anywhere with |
| 72 | + an internet connection. |
| 73 | +- Central to GitHub is that it uses a version control system called |
| 74 | + "Git" |
| 75 | + - In Danish: "versionsstyring" |
| 76 | + - Git: Track changes to files and folders over time (who made the |
| 77 | + changes, when + a message describing the changes) |
| 78 | + - The name "GitHub": A "hub" (central place) for storing and |
| 79 | + sharing files, using Git to track changes |
| 80 | +::: |
| 81 | + |
| 82 | +## What can GitHub be used for? |
| 83 | + |
| 84 | +- Storing and sharing files (while tracking changes) |
| 85 | +- Creating websites |
| 86 | +- Collaboration |
| 87 | + - Reviews: Giving and receiving feedback |
| 88 | + - Communication (tasks, to-do lists, discussions) |
| 89 | + - Project management (project boards) |
| 90 | + |
| 91 | +::: notes |
| 92 | +- Store/share files like documents, images, code for your data |
| 93 | + analyses |
| 94 | +::: |
| 95 | + |
| 96 | +## Why use GitHub? |
| 97 | + |
| 98 | +- Everything related to your project in one place (files, tasks, |
| 99 | + discussions, feedback, project management) |
| 100 | +- Changes are tracked |
| 101 | +- Everything is open and accessible to everyone (unless you make it private) |
| 102 | +- Eases collaboration |
| 103 | + |
| 104 | +::: notes |
| 105 | +- Everything in one place: |
| 106 | + - Files stored in the same place as your tasks, discussions, |
| 107 | + feedback, and project management |
| 108 | + - No need to email files around or having multiple versions of the same file |
| 109 | +- Tracking changes: You can see who did what when + revert to previous |
| 110 | + versions of files if needed |
| 111 | +- Transparency: On GitHub, everything is open and accessible to |
| 112 | + everyone (unless you make it private). This means that anyone can |
| 113 | + see your work, and you can see other people's work. |
| 114 | +::: |
| 115 | + |
| 116 | +## Examples: [GitHub.com](https://github.com) :eyes: |
| 117 | + |
| 118 | +::: notes |
| 119 | +Show: |
| 120 | + |
| 121 | +- The `steno-aarhus` organisation |
| 122 | + |
| 123 | +- Simple example: A website repository (prodiap) |
| 124 | + |
| 125 | + - Files and folders |
| 126 | + - Version control (commits) |
| 127 | + - Issues |
| 128 | + |
| 129 | +- Collaborative example: A Seedcase repository |
| 130 | + |
| 131 | + - Files and folders |
| 132 | + - Issues |
| 133 | + - Pull requests + feedback (find a nice example beforehand) |
| 134 | + - Project board |
| 135 | +::: |
| 136 | + |
| 137 | +## GitHub Intro workshop, May 26 |
| 138 | + |
| 139 | +- Gentle introduction to using GitHub for managing and working with |
| 140 | + files |
| 141 | +- Registration: Mail from Louise |
| 142 | +- Pre-workshop tasks |
| 143 | + |
| 144 | +::: notes |
| 145 | +Pre-workshop tasks: Around 1 hour to complete. Mostly reading to build a |
| 146 | +common foundation for the workshop and get familiar with the concepts |
| 147 | +we'll apply during the workshop. |
| 148 | +::: |
| 149 | + |
| 150 | +## Questions? |
0 commit comments