From 390a447b407455218f6f2b90e59df3cd07286f54 Mon Sep 17 00:00:00 2001 From: Jonas Smedegaard Date: Fri, 4 Jun 2021 15:00:27 +0200 Subject: use inline defined hints --- README.md | 10 +++++++++- USE.md | 16 +++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2b90e48..4d7d2a5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,19 @@ # Overview of shell accounts -{{organisation}} offers optional shell accounts for members. +Example orga offers optional shell accounts for members. User must provide contact information. A shell account provides access to a command-line text console interface. +## Special strings + +NB! This documentation uses special strings +which you may want to adapt for your local setup: + +organisation: Example orga + + ## Privacy Account content is readable by other users by default. diff --git a/USE.md b/USE.md index 6c111ef..64f4640 100644 --- a/USE.md +++ b/USE.md @@ -1,13 +1,13 @@ # Shell introduction -As member of {{organisation}} -you can get a shell account at {{shellhost}}. +As member of Example orga +you can get a shell account at shell.example.org. A shell account provides you a "home" at the system, that you can access with a command-line console interface either interactively or automated by scripts. -You need to {{contact_sysadmins}} to get your shell account created. +You need to contact_sysadmins to get your shell account created. Provide your full name, email, and cellphone number, which is shared with all users for use in case of problems with your account. @@ -15,6 +15,16 @@ You may also suggest a name for your account (only lower-case simple letters). +## Special strings + +NB! This documentation uses special strings +which you may want to adapt for your local setup: + +organisation: Example orga +shellhost: shell.example.org +contact_sysadmins: contact sysadmins + + ## Remote access Your shell environment is accessed via Secure Shell (ssh) -- cgit v1.2.3