Skip to content

Commit 1c32d30

Browse files
authored
Merge pull request #9 from Tiger2lala/main
Update course info, author cards
2 parents dfeb98c + 32edf92 commit 1c32d30

File tree

4 files changed

+36
-58
lines changed

4 files changed

+36
-58
lines changed
Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
1-
- title: Zeus
1+
- title: Minghao Zhang
22
content: |
3-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
4-
Lorem ipsum dolor sit amet.
3+
[:custom-orcid:](https://orcid.org/0000-0002-5401-6070) [:simple-github:](https://github.com/Tiger2lala) [:simple-linkedin:](https://www.linkedin.com/in/minghao-zhang-75471854/)<br>
4+
University of Cambridge
55
image: ./assets/images/cards/001-zeus.png
66

7-
- title: Athena
7+
- title: Gaurav Bhalerao
88
content: |
9-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
10-
Lorem ipsum dolor sit amet.
9+
[:custom-orcid:](https://orcid.org/0000-0002-3325-3413) [:simple-github:](https://github.com/gvbhalerao591) <br>
10+
University of Oxford
1111
image: ./assets/images/cards/003-athena.png
1212

13-
- title: Poseidon
13+
- title: Diana Pilvar
1414
content: |
15-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
16-
Lorem ipsum dolor sit amet.
15+
[:custom-orcid:](https://orcid.org/0000-0002-5788-2687) [:simple-github:](https://github.com/diana-pilvar) <br>
16+
University of Tartu, ELIXIR Estonia
17+
image: ./assets/images/cards/007-poseidon.png
18+
19+
- title: Marina Popleteeva
20+
content: |
21+
[:custom-orcid:](https://orcid.org/0000-0002-8409-6147) [:simple-github:](https://github.com/marikapop) <br>
22+
University of Luxembourg
1723
image: ./assets/images/cards/007-poseidon.png
Lines changed: 3 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,3 @@
1-
- title: Artemis
2-
content: |
3-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
4-
Lorem ipsum dolor sit amet.
5-
image: ./assets/images/cards/021-artemis.png
6-
7-
- title: Ares
8-
content: |
9-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
10-
Lorem ipsum dolor sit amet.
11-
image: ./assets/images/cards/006-ares.png
12-
13-
- title: Nike
14-
content: |
15-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
16-
Lorem ipsum dolor sit amet.
17-
image: ./assets/images/cards/027-nike.png
18-
19-
- title: Prometheus
20-
content: |
21-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
22-
Lorem ipsum dolor sit amet.
23-
image: ./assets/images/cards/019-prometheus.png
24-
25-
- title: Perseus
26-
content: |
27-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
28-
Lorem ipsum dolor sit amet.
29-
image: ./assets/images/cards/025-perseus.png
30-
31-
- title: Hercules
32-
content: |
33-
[:custom-orcid:](https://orcid.org/) [:simple-github:](https://github.com/) [:simple-linkedin:](https://linkedin.com/)<br>
34-
Lorem ipsum dolor sit amet.
35-
image: ./assets/images/cards/042-hercules.png
1+
- title: Kim Martin
2+
content:
3+
image: ./assets/images/cards/007-poseidon.png

docs/index.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,32 @@ Greek Mythology icons made by [max.icons](https://www.flaticon.com/authors/maxic
1010

1111
!!! overview ""
1212
:fontawesome-regular-bookmark: **Description**
13-
Add a short description of the training materail should be inserted here.
13+
Version control is the lab notebook of the digital world. It helps us understand what changes we made in the past and why we did a specific analysis in the way we did it. It is also vital for smooth collaboration where different people work on the same code simultaneously. Using version control for your research project means that your work is totally transparent, and because all your actions are recorded, it enables others to reproduce your studies.
14+
15+
In this series, we will cover the basics of using Git with the GUI provided in PyCharm. Git is a open source, free of charge, and powerful version control tool, and we will demonstrate the few simple steps to boost your code organisation and reproducibility, all without the need of command line knowledge. We will then use GitHub to host and share our scripts, and show hands-on examples of how GitHub can facilitate code collaboration.
16+
1417

1518
</br>
1619

1720
:fontawesome-solid-arrow-left: **Prerequisites**
1821
To be able to follow this course, learners should have knowledge in:
19-
&emsp;1. First requirement
20-
&emsp;2. Second requirement
22+
&emsp;1. No previous knowledge of Git assumed
23+
&emsp;2. Able to understand and write simple Python scripts
2124

2225
</br>
2326

2427
:fontawesome-solid-arrow-right: **Learning Outcomes:**
2528
By the end of the course, learners will be able to:
26-
&emsp;1. First item
27-
&emsp;2. Second item
29+
&emsp;1. Understand the purpose and functionality of version control tools (e.g. Git)
30+
&emsp;2. Know how to create and use a local repository with Git UI in PyCharm
31+
&emsp;3. Know how to collaborate on a remote repository on GitHub
2832

2933
</br>
3034

3135
:fontawesome-solid-users: **Target Audience:** Researchers, undergraduate students, postgraduate students, etc...
3236
</br>
3337

34-
:fontawesome-solid-stairs: **Level:** Beginner/Intermediate/Advanced
38+
:fontawesome-solid-stairs: **Level:** Beginner
3539

3640
:fontawesome-solid-lock: **License:** [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/)
3741

@@ -61,10 +65,9 @@ Please cite as:
6165
---
6266
## Setup
6367

64-
### Data setup
65-
To run this lesson you need to install data from …
66-
6768
### Software setup
68-
To run this course you need to install… continue with software installation instructions
69+
To run this course you need to install Git. Details for Git setup is described in Chapter 3.
70+
71+
We also introduce how to use Git with a GUI (GitHub Desktop as an example) / IDE (PyCharm as an example).
6972

7073

mkdocs.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@ site_name: ELIXIR Training Lesson
22
nav:
33
- About: index.md
44
- Course Content:
5-
- "1. title of first chapter": chapters/chapter_01.md
6-
- "2. title of second chapter": chapters/chapter_02.md
5+
- "1. What is version control": chapters/chapter_01.md
6+
- "2. Git & Git hosting services": chapters/chapter_02.md
7+
- "3. Getting familiar with Git and GitHub": chapters/chapter_03.md
78
- "4. Learn the workflow from case studies": chapters/chapter_04.md
89
- "5. Advanced topics": chapters/chapter_05.md
910
- "6. Data management, data sharing & ethical issues": chapters/chapter_06.md
@@ -23,8 +24,8 @@ theme:
2324
text: Lato
2425

2526
# Repository
26-
repo_name: elixir-europe-training/ELIXIR-TrP-LessonTemplate-MkDocs
27-
repo_url: https://github.com/elixir-europe-training/ELIXIR-TrP-LessonTemplate-MkDocs
27+
repo_name: elixir-europe-training/ELIXIR-TrP-VersionControlPython-CodeRep
28+
repo_url: https://github.com/elixir-europe-training/ELIXIR-TrP-VersionControlPython-CodeRep
2829
edit_uri: edit/main/docs/
2930

3031
plugins:

0 commit comments

Comments
 (0)