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

Corrected typo

parent 26d8aa93
No related branches found
No related tags found
2 merge requests!592Automated merge from preview to main,!554Content rules
...@@ -60,11 +60,11 @@ or via [Email](mailto:hpcsupport@zih.tu-dresden.de). ...@@ -60,11 +60,11 @@ or via [Email](mailto:hpcsupport@zih.tu-dresden.de).
* Example: Use `You can/should ...` instead of `Users can/should ...` * Example: Use `You can/should ...` instead of `Users can/should ...`
* Example: Use `Your contribution is highly welcome` instead of `Contributions from user-side * Example: Use `Your contribution is highly welcome` instead of `Contributions from user-side
are highly welcome` are highly welcome`
* Be brief! Provide the main idea/commands first, special cases later. If it is not necessary to * Be brief! Provide the main idea/commands first, and special cases later. If it is not necessary to
know how a special piece of software works, don't explain it. know how a special piece of software works, don't explain it.
* Provide the often-used commands first. * Provide the often-used commands first.
* Use active over passive voice * Use active over passive voice
* Write with confidence. This confidence should be reflected in the documentation, so that * Write with confidence. This confidence should be reflected in the documentation so that
the readers trust and follow it. the readers trust and follow it.
* Example: `We recommend something` instead of `Something is recommended.` * Example: `We recommend something` instead of `Something is recommended.`
* Capitalize headings, e.g. *Exclusive Reservation of Hardware* * Capitalize headings, e.g. *Exclusive Reservation of Hardware*
...@@ -125,7 +125,7 @@ Further tips can be found at this ...@@ -125,7 +125,7 @@ Further tips can be found at this
#### Graphics and Attachments #### Graphics and Attachments
Please use images and graphics for illustration purposes and to improve understandability. Please use images and graphics for illustration purposes and to improve understandability.
All graphics and attachments are saved within `misc` directory of the respective sub directory in All graphics and attachments are saved within `misc` directory of the respective subdirectory in
`docs`. `docs`.
!!! example "Syntax" !!! example "Syntax"
......
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