Autorenportal
Das Hostsharing-Wiki ist ein gemeinsames Projekt der Hostsharing-Mitglieder, in dem wir die Dokumentation der Dienste von Hostsharing überarbeiten und auf den aktuellen Stand bringen möchten. Auf dieser Seite findest du Informationen dazu, wie du dich daran beteiligen kannst.
Erste Schritte
Anmelden
Das Wiki verwendet den Single-Sign-On-Dienst von Hostsharing, sodass Du Dich im Wiki mit jedem gültigen User (Benutzernamen) eines Servers von Hostsharing anmelden kannst. Du kannst Dir natürlich für die Nutzung des Wikis einen eigenen User in einem Deiner Pakete anlegen, zum Beispiel xyz00-wiki oder xyz00-hsdoku.
Benutzereinstellungen
Nachdem du dich im Wiki angemeldet hast, ist es sinnvoll, wenn du zunächst deine Benutzereinstellungen anpasst (der Link Einstellungen - nur sichtbar, wenn Du angemeldet bist). Mindestens deine E-Mail-Adresse solltest du eintragen, denn dann kannst du Seiten im Wiki beobachten und Nachrichten bekommen, wenn eine von dir beobachtete Seite geändert wurde.
Du solltest dich außerdem auf der Hostsharing-Mailingliste (nicht öffentliche Liste) website@hostsharing.net anmelden. Dort diskutieren wir über die Weiterentwicklung der Dokumentation.
Wo ist Arbeit nötig?
Ganz konkret kannst du zum Beispiel schauen, welche Seiten hier im Wiki als Baustelle gekennzeichnet sind und diese überarbeiten. Oder du erstellst eine ganz neue Dokumentation zu einem Thema.
Natürlich kannst du auch als Benutzer die Dokumentation lesen und in der Diskussion der entsprechenden Seite darauf hinweisen, wo aus deiner Sicht Verbesserungen notwendig sind. Um eine Seite als Baustelle zu kennzeichnen, trage einfach folgendes ganz am Anfang der Seite ein:
{{Baustelle}}
Am Anfang der Seite erscheint dann ein entsprechender Hinweis und die Seite wird in die Liste der Baustellen aufgenommen.
Konventionen
Wenn du an der Dokumentation arbeitest, solltest du unsere Konventionen und Hinweise zu gutem Stil beachten.
Umgang mit der Wiki-Software
Wir verwenden als Software MediaWiki. Nachfolgend einige Links auf Hinweise dazu, wie du im Wiki Texte formatierst und Links anlegst. Gefahrlos ausprobieren kannst du die Wiki-Funktionen auf der Seite Sandkasten, diese ist explizit zum Experimentieren gedacht.
Für den Leser schreiben!
Entgegen der langjährigen Tradition in Akademie und Technik, schreiben wir hier vor allem für diejenigen Leser*innen, die noch nicht das wissen, was wir als Autoren wissen. Deshalb immer beim Schreiben von Dokumentation daran denken, daß der Leser womöglich zum allerersten Mal eine Einrichtung vornehmen will, die uns quasi selbstverständlich ist. Das bedeutet, daß die Anleitungen in diesem Wiki mit genauer Terminologie und ohne allzuviele Abkürzungen ausführlich sagen sollen, was der Leser machen muß.
- Falsch: "Dann über die Shell die entsprechenden Rewrite-Zeilen in die .htaccess einfügen."
- Besser: "Dann mit ssh als Paketuser xyz00-username an example.com anmelden und folgende Zeilen in die Datei ~/doms/example.com/htdocs-ssl/.htaccess einfügen: ..."