Herzlich Willkommen zum Wiki der Gruppe Client Delivery Linux. In diesem Wiki finden sie die Dokumentation der angebotenen Services sowie Tipps und Tricks zu Linux, insbesondere zur Nutzung von Linux im Kontext der ETH Zürich.
Style Guide
Alle Dokumente die Sie hier finden folgen einem bestimmten Dokumentationsstil.
Verzeichnisse und Variablen
Innerhalb eines Fliesstextes werden Verzeichnisnamen und Variablen immer kursiv dargestellt, z.B. /etc/motd
GUI Befehle
Wenn zum Beispiel ein Menüpunkt aufgerufen werden soll, sind die Befehle kurisv dargestellt. Befehlsketten werden mit einem Slash / getrennt. z.B.: Datei / Speichern
Kommandos
Kommandos innerhalb eines Fliesstextes werden in einer Courier Schriftart dargestellt, z.B. service sssd restart
Konfigurationsdateien
Ausschnitte aus Konfigurationsdateien oder Befehlsketten werden ebenfalls in einer Courier Schriftart dargestellt, z.B.:
[libdefaults]
dns_lookup_realm = true
forwardable = true
default_realm = D.ETHZ.CH
rdns = false
default_ccache_name = KEYRING:persistent:%{uid}
Substitutive
In einigen Fällen, werden Sie aufgefordert Variablen durch Ihre persönlichen Werte zu ersetzen. In solch einem Fall wird dies explizit erwähnt und der zu ersetzende Wert durchgängig gross geschrieben, sowie durch Unterstriche getrennt, z.B. IHR_BENUTZERNAME
Hinweise
Wichtige Hinweise werden mit den Wort Hinweis: in Fettschrift versehen. In einigen seltenen Fällen werden einzelne Wörter zur Heraushebung ebenfalls in Fettschrift dargestellt.
Inhaltsverzeichnisse
Ab einer gewissen Länge werden Dokumente mit einem Table of Contents versehen über den Sie einfach zum jeweiligen Abschnitt springen können.
Hinweise für Autoren
Links
Links innerhalb des Wikis werden in Wiki-Syntax erstellt, z.B. [[MeineWikiSeite|Name des Links]]. Externe Links werden über die Sharepoint-Linkfunktion realisiert. Externe Links sowie Links auf Dokumente werden in einem neuen Browser-Tab geöffnet. Interne Links werden im gleichen Browsertab dargestellt.
Feedback
Sollten Ihnen wider Erwarten in Dokumenten Stellen auffallen die nicht diesen Style Guides folgen, würden wir uns über ein kurzes Feedback freuen.