(Providing documentation the OpenShift way – Part 4)
The last two posts described the creation of the generic s2i builder and the concrete documentation site. This blog post now will put all the pieces together and provide a nice package to use on OpenShift or OKD. You get the templates, the build pipeline.
Weiterlesen (Providing documentation the OpenShift way – Part 3)
After preparing the software, now comes the ease part: writing the documentation. Ok, it’s not the easiest part as every developer and system integrator knows.
But generating the documentation pod now is quite easy.
Weiterlesen (Providing documentation the OpenShift way – Part 2)
For building the documentation pod, we need two components: the asciidoc html generator and the webserver for delivering the static pages later. There are several base containers published containing either the asciidoc generator or the webserver. I liked the converter published on https://github.com/asciidoctor/docker-asciidoctor. But that is only the generator part. On the other hand there are default bsic containers like httpd or nginx containing the web server part. Or, as third option you could use a ruby s2i builder as starting point and add both, Asciidoc and the web server later.
Weiterlesen Documentation is one of the most hated part of the life of a developer. So the documentation is often the most neglected part of a project. At work I use Asciidoctor to write my customer documentation and it is quite acceptable. I loved LaTeX and Asciidoctor is an acceptable replacement for technical documentation – especially with the alternatives being google doc or word.
Weiterlesen