Skip to content
Snippets Groups Projects
howto.md 969 B
Newer Older
Ulf Markwardt's avatar
Ulf Markwardt committed
# How to work with the git

Pre-requisites: see [Readme.md](doc.zih.tu-dresden.de/README.md)
Ulf Markwardt's avatar
Ulf Markwardt committed

I want to change something in the RomeNodes.md documentation!

Ulf Markwardt's avatar
Ulf Markwardt committed
```Bash
Ulf Markwardt's avatar
Ulf Markwardt committed
git clone git@gitlab.hrz.tu-chemnitz.de:zih/hpcsupport/hpc-compendium.git
Ulf Markwardt's avatar
Ulf Markwardt committed
cd hpc-compendium/
git checkout preview
Ulf Markwardt's avatar
Ulf Markwardt committed
cd doc.zih.tu-dresden.de
```

## 1. Create a new branch (for instance, using the filename as name of the branch):

```Bash
git checkout -b RomeNodes
```
Taras Lazariv's avatar
Taras Lazariv committed

Ulf Markwardt's avatar
Ulf Markwardt committed
## 2. Edit the file using your preferred editor

## 3. Run the linter:
Taras Lazariv's avatar
Taras Lazariv committed

Ulf Markwardt's avatar
Ulf Markwardt committed
```Bash
Alexander Grund's avatar
Alexander Grund committed
markdownlint ./docs/use_of_hardware/RomeNodes.md
Ulf Markwardt's avatar
Ulf Markwardt committed
```
Taras Lazariv's avatar
Taras Lazariv committed

Ulf Markwardt's avatar
Ulf Markwardt committed
If there are still errors: go to step 2

## 4. Run the link checker:
Taras Lazariv's avatar
Taras Lazariv committed

Ulf Markwardt's avatar
Ulf Markwardt committed
```Bash
Ulf Markwardt's avatar
Ulf Markwardt committed
markdown-link-check ./docs/use_of_hardware/RomeNodes.md
Ulf Markwardt's avatar
Ulf Markwardt committed
```

If there are still errors: go to step 2

## 5. Commit and merge request
Taras Lazariv's avatar
Taras Lazariv committed

Ulf Markwardt's avatar
Ulf Markwardt committed
```Bash
git commit ./docs/use_of_hardware/RomeNodes.md -m "typo fixed"
git push origin RomeNodes    #the branch name
```
Ulf Markwardt's avatar
Ulf Markwardt committed

Taras Lazariv's avatar
Taras Lazariv committed
You will get a link you have to follow to create the merge request.