diff --git a/howto.md b/howto.md index bc48fed969a008ed6ae2e13c08a48a0461ab4ac3..51f73d786d327be1c19589bcc62a437fe305c60e 100644 --- a/howto.md +++ b/howto.md @@ -1,6 +1,6 @@ # 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.