Die Dokumentation ist so gut!

[derRenner]

Leute ihr habt mich jetzt so richtig schön neugierig gemacht

Ich gehöre einerseits zu jeder Kategorie, die sich gerne übersichtliche und leicht verständliche Dokus, Infos, Beschreibungen reinzieht und andererseits dann auch in Notizform noch eigene Vermerke notiert - wo auch immer. Meistens ist es dann so, dass das eine da und das andere dort steht und irgendwie notiere ich mir mein Wissen, wenn ich's dann wieder mal brauche doch wieder auf's neue wiederum irgendwo auf ...
Ja, genauso verwirrend wie sich das liest, versuche ich an Wissen und Infos zu kommen - da ja der Einwand einer nur bedingt verfügbaren Doku schon berechtigt ist.

So, ich habe mir nun mal - ausgehend von der #21 das Wiki doch mal genauer angesehen. Ich kannte es zwar, aber doch irgendwie nur durch die Suche, wo man dann ab und an mal via Verlinkung hinkommt. Ebenso mit der #21 ...
ABER: bei genauerer Betrachtung musste ich feststellen, dass ich ohne den vorhandenen Link, genau diesen einen Wiki-Eintrag gar nicht finde.
Liegt es daran, dass ich das Wiki nicht verstanden habe?
Liegt es daran, dass ich nur an der falschen Stelle gesucht habe, was wiederum die obige Frage rechtfertigen würde?
Oder liegt es daran, dass es hier keine Übersicht/Struktur gibt, die mir diesen Link in einem Art Verzeichnis aufzeigen würde.
... genauso erging's mir aber auch mit anderen Themengebieten, wenn man nicht gerade die links angeordneten Kategorien hernimmt.

So, nun komm' ich mal auf den Punkt:
Gibt's ein Wiki, wo das Wiki erklärt wird?
Ja, ich würde gerne das Wiki näher "kennenlernen" und dann auch, wenn's die Zeit denn zulässt dran mitarbeiten - mit all den Dingen die hier schon diskutiert wurden. Aus der Sicht des Unwissenden, so wie ich einer bin. Aber auch aus der Sicht des Kenners, weil er sich gerade im Selbststudium das eine oder andere Modul, die eine oder andere Erweiterung hatte sich zusammenfrummeln müssen ...

Vieles liest man rasch mal aus einem eindeutigen thread im Forum raus - vieles braucht schon viele Anläufe um zum Ziel zum kommen - vieles braucht externe Seiten - aber ich bin bei euch, wenn jemand dann sagt:"... und warum hast du dein gesammeltes Wissen nicht dem Allgemeingut hinzugefügt ...? "

Also, wo ist das Wiki für das Wiki? Nicht wie ich's bediene, das finde ich hoffentlich dann schon selbst raus ... falls doch nicht, werd ich nachfragen
Ich meine, wie finde ich heraus, ob's einen Beitrag schon gibt, oder nicht - und dann ob dieser aktuell ist oder nicht (OK, das sehe ich dann, wenn ich ihn gefunden habe)

Geht's in diesem Wiki nur um Contao im core? Oder soll/darf das auch mit externen Erweiterungen befüllt werden?
Ist z.B. die Installation von cto4.4 über den Contao-Manager schon zu finden? ... das z.B. hätte ich nicht gefunden.


Ja, Leute ihr seht, ich bin ein Nichtwissender, dem wohl einfach nur der Anstoss fehlt/gefehlt hat - so gesehen: danke für den thread!

[fiedsch]

So, nun komm' ich mal auf den Punkt:
Gibt's ein Wiki, wo das Wiki erklärt wird?

In der Fußzeile des Wikis steht (verlinkt) "Powered by MediaWiki", also www.mediawiki.org/ und dort dann Supprt -> User help

[folkfreund]

@fiedsch: darum geht es doch gar nicht. Ich habe derRenner so verstanden, dass ihm nicht die Bedienung sondern das Verzeichnis existierender Inhalte fehlt. Das lisgt aber in der Natur eines Wiki, da nicht nur die Inhalte, sondern auch die Struktur und die Navigation dynamisch wachsen.
Bei MediaWiki gibt es zum Glück 'Spezialseiten', mit denen sich eventuell etwas aufspüren lässt. Idealerweise werden (wieder-)gefundenen Inhalte dann gleich an zentraler Stelle verlinkt.

Edit: interessant ist z.B. der folgende Link: http://de.contaowiki.org/Spezial:Verwaiste_Seiten

[fiedsch]

@fiedsch: darum geht es doch gar nicht.

Dann habe ich das falsch verstanden, sorry.

[do_while]

Der Menüpunkt "Letzte Änderungen" unter NAVIGATION führt auf jeden Fall zu den letzten Aktivitäten.
Solange das Thema aktuell bearbeitet wird, hat man hier sogar die Übersicht, wer da was ergänzt oder geändert hat.

Natürlich kann man auch auf der Startseite oder den Übersichtsseiten diesen Link nachtragen.

Ich finde auch die Erarbeitung der einzelnen Themen hier im Wiki eine gute Idee, denn hier kann jeder direkt eingreifen. In Github läuft das sicherlich über Pull-Requests und beschäftigt damit noch weitere Leute bevor dann alles in (vorläufig) endgültiger Fassung vorliegt. Ist ein Thema soweit fertig könnte man die Inhalte ins Handbuch übertragen und im Wiki den Inhalt durch einen Link aufs Handbuch ersetzen.

Meiner Meinung nach ist die Hürde vom Wiki kleiner als Pull-Requests in Guthub zu erstellen. Damit haben wir mehr Chancen, dass möglichst viele User sich beteiligen. Jeder hat seine Spezialgebiete, in denen man schon viel ausprobiert hat und einiges beschreiben könnte. Und sollten da Fehler drin sein, ist es jedem freigestellt auch in fremden Einträgen Korrekturen vorzunehmen, oder Sachverhalte auszudiskutieren.

P.S.:
Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren

[folkfreund]

P.S.:
Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren

Danke für den Tipp

[Glumanda]

Ich finde auch die Erarbeitung der einzelnen Themen hier im Wiki eine gute Idee, denn hier kann jeder direkt eingreifen. In Github läuft das sicherlich über Pull-Requests und beschäftigt damit noch weitere Leute bevor dann alles in (vorläufig) endgültiger Fassung vorliegt. Ist ein Thema soweit fertig könnte man die Inhalte ins Handbuch übertragen und im Wiki den Inhalt durch einen Link aufs Handbuch ersetzen.

Meiner Meinung nach ist die Hürde vom Wiki kleiner als Pull-Requests in Guthub zu erstellen. Damit haben wir mehr Chancen, dass möglichst viele User sich beteiligen. Jeder hat seine Spezialgebiete, in denen man schon viel ausprobiert hat und einiges beschreiben könnte. Und sollten da Fehler drin sein, ist es jedem freigestellt auch in fremden Einträgen Korrekturen vorzunehmen, oder Sachverhalte auszudiskutieren.

Wikis sind tot. Niemand will Wikis pflegen. Sich die Arbeit in zig verschiedene Systeme aufzuteilen macht wenig Sinn, damit tun wir uns allen keinen Gefallen. Viele Projekte verwenden mittlerweile Sphinx und Read The Docs. siehe https://docs.typo3.org/ Das macht es wesentlich angenehmer sich da durchzulesen, weil sich Sachverhalte oft ineinander schachteln und man ungern die Übersicht verlieren will. Mit dem "Edit me on GitHub" Button gibt es auch keine Hürde mehr.

[do_while]

Wikis sind tot.

Das sehe ich nicht ganz so.
Warum verteilen sich denn unsere Informationen über so viele Systeme und Webadressen? Weil immer nur die neuesten Tools Verwendung finden, keiner aber die Zeit und Arbeit auf sich nehmen möchte, ältere aber noch gültige Informationen zu portieren. Ich persönlich halte nichts davon, dass man sich alle halbe Jahre in neue Tools einarbeiten soll. Das müßte dann schon ein Super-Überflieger-Werkzeugkasten sein.

[Andreas]

Bei MediaWiki gibt es zum Glück 'Spezialseiten'

Das Suchfeld oben links funktioniert auch sehr gut.

Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren

Muss ich mal ausprobieren. Ansonsten sollte man parallel einen Tab offen haben mit dem Link oben links auf die Hilfe http://de.contaowiki.org/Hilfe:Inhaltsverzeichnis. Dort findet man alles, was eine neue Seite benötigt und die wesentlichen Formatierungen.

[folkfreund]

Viele Projekte verwenden mittlerweile Sphinx und Read The Docs. siehe https://docs.typo3.org/

Interessant, aber wo ist der Unterschied zu einem Wiki (abgesehen von verschiedenen möglichen Exportformaten)? Was ich so auf die Schnelle sehen konnte sieht dem doch verdammt ähnlich, aber vielleicht hab ich ja was übersehen.

Das macht es wesentlich angenehmer sich da durchzulesen, weil sich Sachverhalte oft ineinander schachteln und man ungern die Übersicht verlieren will.

Das Lesen mag ja angenehmer sein, aber die Struktur ergibt sich eben auch nicht 'von alleine'...

[Andreas]

Das Lesen mag ja angenehmer sein

Ja, das Wiki sieht furchtbar aus. Ich benutze das Theme "modern" mit zusätzlichem CSS per Stylish um die Breite zu begrenzen. Damit geht es einigermaßen.

@namespace url(http://www.w3.org/1999/xhtml);

@-moz-document domain("contaowiki.org") {

  body {
    margin: 0 auto !important;
    max-width: 1200px !important;
  }
  #mw_contentwrapper {
    width: 960px !important;
    margin: 0 !important;
  }
  #mw_content {
    margin-left: auto !important;
    margin-right: auto !important;
    width: 960px !important;
  }
  #mw_contentholder pre span {
    background: white !important;
  }
  #mw_portlets {
    background-color: #F8F8F8 !important;
  }
} 

[derRenner]

... Ich habe derRenner so verstanden, dass ihm nicht die Bedienung sondern das Verzeichnis existierender Inhalte fehlt. Das lisgt aber in der Natur eines Wiki, da nicht nur die Inhalte, sondern auch die Struktur und die Navigation dynamisch wachsen. ...

ja, korrekt - das "Verzeichnis", die Übersicht fehlt(e) mir. Wie man das Wiki selbst bedient, schrieb ich auch oben, kann ich mir erlernen bzw. entsprechendes Wissen raussuchen.
Die Frage ging dahingehend, dass man ja so gar nicht erkennt, was denn schon vorhanden ist, oder was nicht.

Ich habe aber jetzt vor diesem Eintrag nochmals etwas genauer geguckt, da ja oberhalb der eine oder andere sehr gute Hinweis aufgetaucht ist und konnte schon mal mehr erkennen.
Also, ich werde mir die Tage das dann nochmals genauer reinziehen und ich denke, dass ich da schon mal bereit bin, mein Wissen entsprechend mit einzutragen.

Der Tipp mit 'Libre Office' gefällt mir ... wieder mal ein Grund mehr, sich das Teil auf die Festplatte zu bannen

[joe]

Letztlich haben wir mit gitbook bereits eine ähnliche Lösung. Ich finde auch, dass das Wiki ausgedient hat. Modul Dokus gehören in die Readme des Moduls und der Rest in das Contao Cookbook. Zu dem habe ich eine Awesome List angelegt (wie alle guten Systeme) und würde die gerne noch nach Awesome List Norm anlegen damit sie auch in die Awsome List aufgenommen wird. Das gehört dann m.E. Auch ins gitbook.

Viele erfolgreiche Systeme zeigen den Weg. Es ist m.E. Zeit sich von alten Strukturen zu lösen die das Contao Projekt isolieren und seit Jahren in seiner Entwicklung behindern.

Bzgl. Doku war ich sehr angetan vom webpack ziklus. Ich denke es sollte Geld aus der Association Kasse in die Hand genommen werden oder ,wenn das warum auch immer nicht möglich ist, ähnlich wie bei Vuejs Patreon für die Finanzierung des Cores/ Doku und Open Collective für Community Finanzierung verwendet werden.

[bibib]

Genauso ist es. Ich weiß wovon ich Rede. Ich habe technische Dokumentation mal ein paar Jahre beruflich gemacht.

Und da beißt sich gelegentlich die Katze sogar in den Schwanz, denn sobald man das nötige Wissen hat, fehlt möglicherweise schon wieder der Blick des Unwissenden.

Ich würde gerne etwas beitragen. Grundsätzlich gefällt mir die Vorgangsweise, bei denen nachzufragen zu dürfen, die sich auskennen, und die Informationen dann auf ganz kleine Häppchen herunterzubrechen und für sich und andere nachvollziehbar zu machen.

Mir ist sehr wohl bewusst, dass Dokumentationen ordentlich viel Zeit verschlingen (ich versuche ja auch immer, für mich Vorgangsweisen zu dokumentieren), aber wenn ich mir vorstelle, wieviel Zeit ich damit verbringe, nach Informationen zu suchen, weil ich mich hinten und vorne nicht auskenne, dann denke ich, dass man diese Zeit ja sinnvoller investieren könnte und dann gleich den Nutzen hat, sich selbst viel besser auszukennen.

Aber meine großes Fragezeichen im Kopf dazu ist: Wie unwissend darf man denn sein, um sich für so eine Aufgabe anzubieten?

Edit:
Oha, ich habe gerade gesehen, dass es hier ja um Entwickler-Fragen geht. Meine Frage war natürlich eher auf allgemeine Contao-Themen bezogen.