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

Restructure code blocks in README.md

parent 9e8cf4f9
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!186Readme update
...@@ -303,7 +303,7 @@ changes to make sure your commit passes the CI/CD pipeline. ...@@ -303,7 +303,7 @@ changes to make sure your commit passes the CI/CD pipeline.
### Check Code and Commands ### Check Code and Commands
1. All code blocks and commands should be runnable from a login node. The script `xyz.sh` checks if the code chunks are runnable on a login node. It is invoked as follows ...
**TODO:** Implement [Issue #9](#9) **TODO:** Implement [Issue #9](#9)
...@@ -351,9 +351,8 @@ structure. ...@@ -351,9 +351,8 @@ structure.
### Markdown ### Markdown
1. Please keep things simple, i.e., avoid using fancy markdown dialects. 1. Please keep things simple, i.e., avoid using fancy markdown dialects.
* [Cheat Sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
* [Cheat Sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) * [Style Guide](https://github.com/google/styleguide/blob/gh-pages/docguide/style.md)
* [Style Guide](https://github.com/google/styleguide/blob/gh-pages/docguide/style.md)
1. Do not add large binary files or high resolution images to the repository. See this valuable 1. Do not add large binary files or high resolution images to the repository. See this valuable
document for [image optimization](https://web.dev/fast/#optimize-your-images). document for [image optimization](https://web.dev/fast/#optimize-your-images).
...@@ -370,14 +369,6 @@ should be highlighted, etc. Code examples, longer than half screen height should ...@@ -370,14 +369,6 @@ should be highlighted, etc. Code examples, longer than half screen height should
[...] [...]
``` ```
### Code Blocks and Commands
* Use ticks to mark code blocks and commands, not italic font.
* Specify language for code blocks, refer to [highlight.js](https://highlightjs.org/static/demo/)
for supported languages.
### Writing Style ### Writing Style
**TODO** Guide [Issue #14](#14) **TODO** Guide [Issue #14](#14)
...@@ -403,15 +394,21 @@ there is a list of conventions w.r.t. spelling and technical wording. ...@@ -403,15 +394,21 @@ there is a list of conventions w.r.t. spelling and technical wording.
Showing commands and sample output is an important part of all technical documentation. Thus, some Showing commands and sample output is an important part of all technical documentation. Thus, some
rules have to be followed. rules have to be followed.
1. Use ticks to mark code blocks and commands, not italic font.
1. Specify language for code blocks, refer to [highlight.js](https://highlightjs.org/static/demo/)
for supported languages.
1. All code blocks and commands should be runnable from a login node.
1. Prompts: It should be clear from the prompt, where the command is run (e.g. Taurus, specific 1. Prompts: It should be clear from the prompt, where the command is run (e.g. Taurus, specific
partition or local machine). partition or local machine).
* Taurus / HPC systems of TUD in general: `taurus$`
* Taurus / HPC systems of TUD in general: `taurus$` * Specific kind of node or partition: `tauruslogin$`, `taurus-ml$` `taurus-rome$`etc.
* Specific kind of node or partition: `tauruslogin$`, `taurus-ml$` `taurus-rome$`etc. * TODO: Remove prefix `taurus`? [Issue #40](#40)
* TODO: Remove prefix `taurus`? * Local machine: `localhost$`
* Local machine: `localhost$` * No output: Omit prompt (copy-paste)
* No output: Omit prompt (copy-paste) * With Output: Add prompt (make clear what is the command and what is the output)
* With Output: Add prompt (make clear what is the command and what is the output)
### Data Privacy and Generic User Name ### Data Privacy and Generic User Name
......
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