Bevor ihr einen Thread im Bereich "HowTos & Wiki" eröffnet bitte lesen

Status
Für weitere Antworten geschlossen.

Rakor

Administrator
Teammitglied
Hallo zusammen,

wir bieten euch hier im Forenbereich "HowTos & Wiki" die Möglichkeit eure Erkenntnisse festzuhalten und mit anderen zu teilen. Hier könnt ihr spezielle Tricks und Kniffe oder kleine Anleitungen dokumentieren. Wollt ihr jedoch eine umfangreiche Anleitung schreiben in der die Einrichtung einer kompletten Applikation erläutert, oder ein anderer Sachverhalt umfassend betrachtet wird, dann nutzt bitte unser Wiki dafür.

Anleitungen und HowTos im Forum
Ihr habt nur ein kleines HowTo oder einen praktischen Kniff den ihr festhalten und anderen Nutzern anbieten wollt? Dann ist der HowTo-Bereich hier im Forum dazu prädestiniert. Bitte schreibt euer HowTo so, dass ein Leser die Schritte gut nachvollziehen kann und die Grundvoraussetzungen kennt die benötigt werden (Welches System setzt ihr ein? Gibt es bestimmte Rahmenbedingungen? Welches Problem behebt ihr ggf. damit? etc.). Im Forum können andere Benutzer sich zu eurem HowTo äußern, Fragen stellen oder Hinweise zur Verbesserung geben. Ihr könnt jedoch euer ursprüngliches HowTo nicht weiterentwickeln, da ihr euren Eingangspost später nicht mehr editieren könnt (damit wollen wir gewährleisten, dass Threads im Nachgang noch nachvollziehbar sind). Ein interessierter Leser muss später also ggf. den kompletten Thread lesen um alle Informationen zum Thema zu erhalten.
Daher eignet sich das Forum selbst auch nicht um umfangreiche Artikel abzulegen, die sich entwickeln sollen. Das Forum kann aber sehr wohl der Geburtsort für einen umfangreichen Wiki-Artikel sein. Wenn ihr z.B. erst noch Meinungen von anderen Benutzern einholen wollt oder das Ganze erst mal öffentlich besprochen werden soll, dann kann das Forum hier die ideale Plattform sein um euren Wiki-Artikel zur Diskussion stellen.


Artikel im Wiki
Wenn ihr einen etwas komplexeren Artikel starten wollt, der sich ggf. mit der Zeit weiterentwickeln und für Andere eine langfristige Quelle darstellen soll, dann ist unser Wiki der richtige Ort dafür.
Das Wiki wird über Github-Pages gehostet. Damit setzen wir auf aktuell gängige Praxis zur Collaboration für die Pflege der Artikel.
  • Der Quellcode in Restructured Text findet sich unter https://github.com/bsdforen/wiki. Beitragen kann jeder der mag mit dem ganz normalen Github-Workflow. Das Repository in den eigenen Account klonen, die Änderung vornehmen und committen, anschließend ein Pull Request stellen. Schon ist (nach einer kurzen Prüfung) eurer Beitrag in unserem Wiki.
  • Der Quellcode wird per Sphinx in statisches HTML gerendert und wie gehabt unter https://wiki.bsdforen.de bereitgestellt. Natürlich kann man es sich selbst rendern und lokal nutzen.
Genauere Infos zum technischen Hintergrund findet ihr noch in hier: https://www.bsdforen.de/threads/das-neue-bsdforen-de-wiki.35214/#post-314089

Wenn ihr einen Artikel ins Wiki stellen wollt solltet ihr vorher kurz nachsehen ob es einen entsprechenden Artikel ggf. bereits gibt. In diesem Fall wäre es möglicherweise der bessere Ansatz den bestehenden Artikel zu überarbeiten. Gibt es noch keinen entsprechenden Artikel, oder euer Sachverhalt unterscheidet sich grundsätzlich, dann könnt ihr einen neuen Artikel einstellen. Ein Artikel muss kein Roman sein, aber er sollte schon einen gewissen Gehalt haben und gut nachzuvollziehen sein. Erläutert also auf jeden Fall auch im Wiki-Artikel genau was ihr betrachtet und wie die Voraussetzungen sind.
Der Vorteil bei einem Wiki-Artikel ist, dass er sich nach und nach entwickeln kann. Ihr und auch andere Nutzer können in der Zukunft Änderungen und Verbesserungen durchführen um den Artikel reifen und Änderungen im Sachverhalt einfließen zu lassen.
 
Zuletzt bearbeitet:
Status
Für weitere Antworten geschlossen.
Oben