Skip to content
Snippets Groups Projects
Commit a90e55b4 authored by Taras Lazariv's avatar Taras Lazariv
Browse files

Merge branch 'mark--tu-dresden.de-preview-patch-36813' into 'preview'

Update howto.md

See merge request !232
parents 9967098f 9493465f
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!232Update howto.md
# How to work with the git
Pre-requisites: see Readme.md
Pre-requisites: see [Readme.md](doc.zih.tu-dresden.de/README.md)
I want to change something in the RomeNodes.md documentation!
......@@ -16,15 +16,19 @@ cd doc.zih.tu-dresden.de
```Bash
git checkout -b RomeNodes
```
## 2. Edit the file using your preferred editor
## 3. Run the linter:
```Bash
markdownlint ./docs/use_of_hardware/RomeNodes.md
```
If there are still errors: go to step 2
## 4. Run the link checker:
```Bash
markdown-link-check ./docs/use_of_hardware/RomeNodes.md
```
......@@ -32,15 +36,10 @@ markdown-link-check ./docs/use_of_hardware/RomeNodes.md
If there are still errors: go to step 2
## 5. Commit and merge request
```Bash
git commit ./docs/use_of_hardware/RomeNodes.md -m "typo fixed"
git push origin RomeNodes #the branch name
```
You will get a link you have to follow to create the merge request.
You will get a link you have to follow to create the merge request.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment