Puppet Dokumentation vom Kugelschreiber

[Kugelschreiber]

Fortgeschrittener Zwischenstand.

Daher werde ich im ersten Schritt die Eingabedateien (Markdown) auf GitLab hochladen. Damit wäre der neuste Stand gesichert.

Ist erfolgt.

"Sphinx" unter Windows war (nach meiner Erinnerung) recht mühselig. Unter Linux wird die Installation einfach(er) sein...

Und tatsächlich ist es Sphinx geworden, weil die erzeugten Dokumente brauchbarer sind.

Später könnte das Repository durch einzelne Zieldokumente ergänzt werden.

Das steht noch aus, auch wenn die ebenfalls hochgeladene index.html-Datei was anderes vermuten lässt. Ich tendiere zu dem "Read the Docs" Theme (man bemühe die Web Suche für einen optischen Eindruck, wie das ausschaut...).

---

Dass hier keine URL hinterlegt ist, ist Absicht. So findet man die Liste manuell:

Web suche nach "gitlab explore" - Auf der GitLab Explore Seite: Oben im Suchfeld "kuli pup". - Damit kommt man zu der öffentlichen Version eines Mara Puppets und der Puppet Befehlsliste (bislang nur Sourcen, aber keine generierte Liste).

---

Damit ist die Puppet Befehlsliste a'la kuli nun von meiner Person unabhängig. Somit habe ich meine Zusage erfüllt.

Grüße, kuli

[Silbermondauge]

Damit ist die Puppet Befehlsliste a'la kuli nun von meiner Person unabhängig. Somit habe ich meine Zusage erfüllt.

Grüße, kuli

Danke schön. Hab mir mal einen lokalen clone angelegt und schaue es mir die Tage an.

Da inzwischen die Wahrscheinlichkeit, meinen Puppet Debugger für Eclipse wiederzubeleben und in einen brauchbaren Zustand zu bekommen gestiegen sind, ist das sicher eine Hilfe. Falls mir dann beim Testen was auffällt was in der Doku nicht passt oder fehlt, kann das ggf. dann auch einfließen. Ggf. über fork, wenn Du Dich puppettechnisch mal komplett zurückziehen solltest.

[Kugelschreiber]

1) ... Falls mir dann beim Testen was auffällt was in der Doku nicht passt oder fehlt, kann das ggf. dann auch einfließen.
2) Ggf. über fork, wenn Du Dich puppettechnisch mal komplett zurückziehen solltest.

Aktuell gerne als PN. Fehler würde ich bei Gelegenheit korrigieren.
Zudem steht noch ein Abgleich mit der temporären, lokalen Pandoc Version aus.

Danke.

Zu 2)
Ja, kann mittelfristig ein Thema sein.

---

Hinweis: Mit drei der bei Sphinx mitgelieferten Themes, und zusätzlich Read the Doc, lässt sich die Dokumentation auf einem frisch installierten Linux Mint 19.x erzeugen. Das wird dann in ein Verzeichnis build geschrieben.

Im Repository werden weitere / abweichende Verzeichnisse vorhanden sein, um ggfls weitere Generatoren zu nutzen - und auf oberster Ebene die generierten Dokumente (zwecks leichterer Auffindbarkeit) zu hinterlegen.

Grüße, kuli

[Kugelschreiber]

Hochgeladen (GitLab)
- V1.40.2 (+SQRT >> Danke an Silbermondauge für den Hinweis)
- +EPUB und +PDF im "Read_the_Doc" Theme
- HTML, SingleHtml und DirHtml sind mir aktuell zu viele Einzeldateien...

Grüße, kuli

[Talkon]

Das ist wirklich klasse 

Ich habe mir das Repo auch geclont und die Doku in verschiedenen Formaten erzeugt. Klappt sehr gut.

Auf dem Wege bleibt die schöne Doku wenigstens erhalten. 

[Kugelschreiber]

... und die Doku in verschiedenen Formaten erzeugt ...

Meinst du damit die Möglichkeiten von Sphinx (Html, SinhleHtml, DirHtml, Latex/PDF, ... und wie sie alle heissen); ggfls in unterschiedlichen Themes?

Oder hast du was anderes gemacht? Ich bin immer auf der Suche nach schicken bzw. praktischen Alternativen.

Danke für Anregungen.

Grüße, kuli

PS: vermutlich unter Linux?!

[Talkon]

Ich habe die gängigen Formate pdf, epub und htlm mit sphinx erzeugt. Einmal mit Linux und einmal mit Cygwin unter Windows. Bei Cygwin mußten noch die ganzen latex live pakete installiert werden, dann lief das problemlos durch.

Andere Alternativen habe ich bis jetzt noch nicht probiert.

Grüße Talkon

[Kugelschreiber]

Guten Abend,

aufgrund eines Hinweises von King.Cricco habe ich feststellen müssen, dass mind. ein längeres Kapitel (Puppettypen, ASP, ...) bei dem Rumgehampel mit verschiedenen Rechnern, Betriebssystemen, Tools und Versionen der Dokumentation vorläufig untergegangen ist.

Das werde ich "bei Zeiten" überprüfen und nachliefern.

Grüße, kuli

[Kugelschreiber]

... Kapitel (Puppettypen, ASP, ...) ...

Hochgeladen (GitLab)
- V1.40.3 (+Kapitel "Puppets", -Kapitel "Anhang")

Grüße, kuli

PS: Die Version beim ersten Einchecken war "1.40.1". Der Eincheck Kommentar von "damals" gibt eine falsche "1.40.4" an. Nun ist es "1.40.3".

[Kugelschreiber]

Sourcen zu Marapuppet und Puppetdokumentation sind meine Hinterlassenschaft für die BSW Allgemeinheit.

Bleibt gesund. - Vielleicht liest man sich später nochmal.

[Silbermondauge]

Sourcen zu Marapuppet und Puppetdokumentation sind meine Hinterlassenschaft für die BSW Allgemeinheit.

Bleibt gesund. - Vielleicht liest man sich später nochmal.

Verstehe ich das richtig, dass jetzt die Zeit von Deinem Rückzug aus dem Thema gekommen ist? Dann bedanke ich mich für das was Du für die Puppet- und die Marathonwelt gemacht hast.

Wenn Du nichts dagegen hast werde ich (gern zusammen mit anderen) so gut wie möglich bei Fragen helfen und vielleicht auch bei dem einen oder anderen Bugfix.

Vielleicht sieht man sich ja irgendwann mal wieder. Und sei es zu einem Spielchen ohne Verpflichtungen