Dokumentation wird Open Source

vorhergehende Artikel in: dWb+ Markup Git(lab|hub)
04.11.2021

Ich habe im Zuge der Aktualisierung der Dokumentation für meinen Static Site Generator dessen Dokumentation wie auch die für dWb+ und Aviator unter der bekannten Lizenz als Open Source auf Gitlab zur Verfügung gestellt.

Für die sQLshell habe ich mich bei Projektbeginn für JavaHelp als Dokumentationsmedium entschieden - das wird sich auch nicht ändern.

Danach stieß ich auf DocBook und habe seither größere Dokumentationen immer damit erstellt. Ich bin zwar erfreut über die Vielseitigkeit von Markdown und werde auch wo immer es geboten ist weiterhin TeX einsetzen - aber für die Erstellung größerer Dokumentationen ist nach wie vor DocBook mein Mittel der Wahl.

Daher überlegte ich neulich (und wegen der Tatsache, dass mir die Erstellung der Dokumentationen aus den DocBook-Quellen mittels ANT schon immer ein wenig sperrig und unhandlich erschien), ob es nicht ein entsprechendes Maven-Plugin gäbe, das diese Aufgabe eventuell mit weniger Schmerzen erledigen könnte.

Nach kurzer Suche stieß ich auf docbkx, das alle meine Erwartungen übertraf.

Dadurch wurde mein Entschluss bestärkt, die bestehenden Dokumentationen für meinen Static Site Generator dessen Dokumentation wie auch die für dWb+ und Aviator als Open Source Projekte zu veröffentlichen. Die entsprechenden Repositories sind auf Gitlab für die Dokumentation des Static Site Generator wie auch die Dokumentation für dWb+ und die Dokumentation für den Aviator verfügbar.

Artikel, die hierher verlinken

Annotation Processing zur leichteren Erstellung von Modulen für dWb+

28.07.2024

Nach meinem letzten Artikel zum Thema dWb+ habe ich dieses Jahr wieder einmal die Dokumentation kritisch gelesen und festgestellt, dass ein in den letzten Jahren immer mehr ausgebautes Feature dort noch nicht auftauchte.

Neuigkeiten zu dWb+

16.07.2022

Nach meinem letzten Artikel zum Thema dWb+ ist bereits einige Zeit vergangen - daher hier ein kurzes Update mit einem Ausblick auf die nächste Version.

CI/CD Pipelines für DocBook-Dokumentationen

28.12.2021

Nachdem ich neulich die Handbücher für die Anwendungen dWb+ und EBCMS sowie für das Framework dmcc, das beispielsweise im Aviator und auch in dWb+ zum Einsatz kommt auf Gitlab veröffentlicht habe, habe ich entsprechende CI/CD Pipelines eingerichtet, die dafür sorgen, dass die aktuelle Version der jeweiligen Handbücher immer als PDF und EPUB abgerufen werden kann.

Alle Artikel rss Wochenübersicht Monatsübersicht Github Repositories Gitlab Repositories Mastodon Über mich home xmpp


Vor 5 Jahren hier im Blog

  • Testdatengeneratoren als Microservices mit Docker

    02.11.2019

    Ich habe die verschiedenen Testdatengeneratoren mittels Microservices über HTTP zugänglich gemacht, um sie unabhängig von der verwendeten Programmiersprache und/ oder Version (Java 11) verwenden zu können.

    Weiterlesen...

Neueste Artikel

  • Generator für syntaktisch korrekten Python Code

    Nachdem es nun bereits seit einiger Zeit ein wenig stiller um meine diversen Generatoren für Testdaten geworden ist, habe ich über den Feiertag in Thüringen einen neuen begonnen.

    Weiterlesen...
  • ethersyncj - Java Bindings für Ethersync

    Ich wurde über einen Post auf Mastodon auf ein Projekt aufmerksam, das mir so interessant erschien, dass ich daraus meine neueste Fingerübung machte...

    Weiterlesen...
  • sQLshell Version 7.7pre8 build 10681

    Eine neue Version der sQLshell ist verfügbar!

    Weiterlesen...

Manche nennen es Blog, manche Web-Seite - ich schreibe hier hin und wieder über meine Erlebnisse, Rückschläge und Erleuchtungen bei meinen Hobbies.

Wer daran teilhaben und eventuell sogar davon profitieren möchte, muß damit leben, daß ich hin und wieder kleine Ausflüge in Bereiche mache, die nichts mit IT, Administration oder Softwareentwicklung zu tun haben.

Ich wünsche allen Lesern viel Spaß und hin und wieder einen kleinen AHA!-Effekt...

PS: Meine öffentlichen GitHub-Repositories findet man hier - meine öffentlichen GitLab-Repositories finden sich dagegen hier.