Hilfe:Styleguide
Inhaltsverzeichnis
definitive Bezeichnungen
Nach Konvention sollen die Bezeichnungen jeweils fett geschrieben werden.
| Bezeichnung | Bedeutung |
|---|---|
| Lokaler-Benutzername | Lokaler Benutzer auf eigenen Rechner |
| Lokales-Benutzerpasswort | Passwort des lokalen Benutzers auf eigenem Rechner |
| Lokales-Rootpasswort | Passwort des lokalen Root-Benutzers (Superuser) auf eigenem Rechner |
| HSR-Benutzername | Benutzername von der HSR |
| HSR-Passwort | Passwort des HSR-Benutzers |
Links auf Passwortgeschützte Seiten
Auf Dokumente welche durch Verschleierung geschützt sind und man für die Linkseite ein Passwort braucht darf nicht direkt gelinkt werden! (z.B. VPN-Seiten der ID) ebenso ist darauf zu achten, das keine interen Passwörter im Wiki vorkommen.
Shell
Eine root-Shell wird mit # markiert
# whoami root
Eine normale Shell wird mit $ gekennzeichnet
$ whoami normaleruser
Die bash gilt als Standard-Shell.
Sprache/Version
Die Anleitungen werden auf Deutsch verfasst, die Screenshots sollten auf einem englischsprachigem System angefertigt werden. Analog den HSR-Anleitungen. Bei jeder Seite sollte am Schluss vermerkt werden für welche Ubuntu-Version die Anleitung geschrieben/getestet wurde.
Shell vs. GUI
Was immer einfach über die GUI gelöst werden kann, soll auch damit gelöst werden. Wir sollten keinem Neuling ein "tar xfj blablub.tar.bz2" zumuten, wenn es mittels zwei Klicks über die GUI genauso gut geht.
Änderungen
Bei Änderungen einer Seite ist stets eine Zusammenfassung zu machen also z.B.
Erweitert um Änderungen
Dazu bitte das "Zusammenfassung"-Feld von MediaWiki verwenden (befinden sich auf der Editier-Seite oberhalb der Buttons).
Des weiteren hilft die Vorschau um Fehler zu sehen bevor man den Artikel freigibt und eine Änderung im Log verursacht.
Änderungsnotiz
Falls eine Seite nicht mehr aktuell scheint, so kann dies über einen entsprechenden Hinweis am Anfang der Seite einfach angezeigt werden: {{PleaseUpdate}} Dadurch wird das Template PleaseUpdate eingebunden, welches folgenden Text generiert:
Notiz: Diese Anleitung wurde nicht mit der aktuellsten Version von Ubuntu erstellt. Einige Schritten können daher abweichen. Bitte gelegentlich diese Anleitung aktualisieren. Falls die Anleitung immer noch unverändert Gültigkeit besitzt, bitte diese Notiz wieder entfernen.
