Skip to content
Snippets Groups Projects
Commit 4f351434 authored by Martin Schroschk's avatar Martin Schroschk
Browse files

Merge branch 'content_rules' into 'preview'

Turn code block into example

See merge request !1062
parents 775bff16 fa3cb49c
No related branches found
No related tags found
2 merge requests!1071Automated merge from preview to main,!1062Turn code block into example
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
## Motivation and Rationale ## Motivation and Rationale
This page holds rules regarding the layout, content, and writing of this This page holds rules regarding the layout, content, and writing of this
documentation. The goals are to provide a comprehensive, consistent, up-to-date and well-written documentation. The goals are to provide a comprehensive, consistent and well-written
documentation that is pure joy to read and use. It shall help to find answers and provide knowledge documentation that is pure joy to read and use. It shall help to find answers and provide knowledge
instead of being the bottleneck and a great annoyance. Therefore, we set up some rules which instead of being the bottleneck and a great annoyance. Therefore, we set up some rules which
are outlined in the following. are outlined in the following.
...@@ -330,7 +330,7 @@ placeholders. In particular, use the generic placeholders depicted in the follow ...@@ -330,7 +330,7 @@ placeholders. In particular, use the generic placeholders depicted in the follow
The table also holds a second placeholder, if, e.g., you need a second login to formulate an example. The table also holds a second placeholder, if, e.g., you need a second login to formulate an example.
| Description | Placeholder | 2nd Placeholder | | Description | Placeholder | 2nd Placeholder |
|---|---| |---|---|---|
| Username | Marie | Martin | | Username | Marie | Martin |
| Login | `marie` | `martin` | | Login | `marie` | `martin` |
| E-mail | marie@tu-dresden.de | martin@tu-dresden.de | | E-mail | marie@tu-dresden.de | martin@tu-dresden.de |
...@@ -338,12 +338,17 @@ The table also holds a second placeholder, if, e.g., you need a second login to ...@@ -338,12 +338,17 @@ The table also holds a second placeholder, if, e.g., you need a second login to
| Workspace title | `number_crunch` | `long_computations` | | Workspace title | `number_crunch` | `long_computations` |
{: summary="Generic placeholders", align="bottom"} {: summary="Generic placeholders", align="bottom"}
```console !!! example "Output of `ls` command"
marie@login$ ls -l
drwxr-xr-x 3 marie p_number_crunch 4096 Jan 24 2020 code The following code listing depicts the usage of the generic user names and projects as well as
drwxr-xr-x 3 marie p_number_crunch 4096 Feb 12 2020 data recognizable placeholders for files and directory names.
-rw-rw---- 1 marie p_number_crunch 4096 Jan 24 2020 readme.md
``` ```console
marie@login$ ls -l
drwxr-xr-x 3 marie p_number_crunch 4096 Jan 24 2020 code
drwxr-xr-x 3 marie p_number_crunch 4096 Feb 12 2020 data
-rw-rw---- 1 marie p_number_crunch 4096 Jan 24 2020 readme.md
```
!!! info "Marie" !!! info "Marie"
......
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