From 42aecd853277a6a5bb0a48539cd376a4d85ed3e7 Mon Sep 17 00:00:00 2001 From: Martin Schroschk <martin.schroschk@tu-dresden.de> Date: Wed, 24 Apr 2024 14:20:51 +0200 Subject: [PATCH] rules: Refine generic names and placeholders --- .../docs/contrib/content_rules.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md index 61391c918..1a325b90c 100644 --- a/doc.zih.tu-dresden.de/docs/contrib/content_rules.md +++ b/doc.zih.tu-dresden.de/docs/contrib/content_rules.md @@ -326,9 +326,17 @@ highlighting. There is a complete list of supported #### Data Privacy and Generic Names Where possible, replace login, project name, and other private data with clearly recognizable -placeholders. In particular, use the generic login `marie` and the project title `p_number_crunch` -as placeholders at first. If you need a second login and a second project stick to `martin` and -`p_long_computations`. +placeholders. In particular, use the generic placeholders depicted in the following table. +The table also holds a second placeholder, if, e.g., you need a second login to formulate an example. + +| Description | Placeholder | 2nd Placeholder | +|---|---| +| Username | Marie | Martin | +| Login | `marie` | `martin` | +| E-mail | marie@tu-dresden.de | martin@tu-dresden.de | +| Project title | `p_number_crunch` | `p_long_computations` | +| Workspace title | `number_crunch` | `long_computations` | +{: summary="Generic placeholders", align="bottom"} ```console marie@login$ ls -l -- GitLab