Skip to content

Commit b0bc06a

Browse files
authored
Merge pull request #8 from diana-pilvar/main
added text to chapter 1
2 parents 02d5602 + df7393c commit b0bc06a

1 file changed

Lines changed: 17 additions & 19 deletions

File tree

docs/chapters/chapter_01.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
1-
## 1.1 First subtopic
2-
Here you can enter text and create inline citations[@Garcia2020] by using the bibtex plugin. Add your references in `references.bib`, and cite [@hoebelheinrich_nancy_j_2022_6769695] by adding the @refid inside brackets like this `[@10.1093/bioinformatics/btt113]`
1+
## 1.1 What is version control?
2+
Version control is a class of systems that record changes to a file or set of files over time so that you can recall specific versions later.
33

4-
You can also embed videos from a local source (with a relative path) or from an url (like youtube). To use a youtube URL,
5-
just attach the ID of the video to a youtube embedded video link: `https://youtube.com/embed/`. For example, the Elixir training video `https://youtu.be/oAD8FdGf8tI` has the ID `oAD8FdGf8tI`, so the final link would be:
4+
Changes are usually identified by a number or letter code. For example, an initial set of files is "version 1" or "revision 1". When the first change is made, the resulting set is "version 2" or "revision 2", and so on. Each revision is associated with a timestamp and the person making the change.
65

7-
```
8-
![type:video](https://youtube.com/embed/oAD8FdGf8tI)
9-
```
10-
11-
![type:video](https://youtube.com/embed/oAD8FdGf8tI)
12-
13-
## 1.2 Second subtopic
14-
15-
!!! note "Note"
16-
17-
Here you can put a note using admonitions.
18-
19-
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
20-
21-
## 1.3 Third subtopic
6+
## 1.2 Why do we need version control?
7+
There are multiple reasons why version control has become necessary:
8+
- **Tracking changes.** You can keep every version of an image, code or text. With each version, you can add message explaining why and what was changed. This way you can see how the file evolves over time.
9+
- **Tracking Ownership.** Version control keeps track of who made changes and you can see how much effort each person has put into a project to give credit accordingly.
10+
- **Backup and restore.** When some part of your work gets accidentally deleted, it is easy to recover it. You can also recover a file as it was a few weeks/months/years ago.
11+
- **Synchronization.** With big projects, multiple people are working on the same files. With version control programs it is easy to share files and keep your files updated to the latest version.
12+
- **Short-term undo.** Accidentally messed up a file? No worries, recover the last known good version.
13+
- **Long-term undo.** Introduced a bug a year ago? Jump back to that old version, see what change was made and why.
14+
- **Sandboxing.** Basicly an insurance. When implementing a big change you can test it in an isolated area and resolve bugs before applying them.
15+
- **Branching and Merging.** You branch (copy the project to yourself)
2216

2317

18+
## 1.3 Available version control tools
2419

20+
### 1.3.1. Commercial
21+
### 1.3.2. Open Source
22+
### 1.3.3. Cloud-based

0 commit comments

Comments
 (0)