Doc as Code with Asciidoctor, Jekyll, and TravisCI

Goals: (Subject to change)

  • Setup TravisCI to publish doc branches from a product repo to a default build location for continuous version/building
  • Lower the barrier for documentation contributors by migrating to Asciidoc as a source format (In place of Docbook XML)
  • Use Jekyll for generating the static content + Bootstrap / Foundation or similar
  • Begin work on a clear and consistent UX theme

Examples


Markdown Demo

Based on a home hackproject, this will be replaced by Asciidoc and a custom SUSE theme.

  1. From the demo homepage, select Available Versions
  2. Select SUSE Manager Server 3.1 Stable
  3. Select WebUI Reference > Systems > All Systems
  4. Notice the Edit me button at the top of the Systems page. Click the Edit me button
  5. You will be redirected to the markdown document in the product github repository
  6. Login make your changes, and then submit a PR "this is the doc as code process"
  7. A writer reviews PR and accepts, rejects or requests changes or more info
  8. If accepted Jekyll rebuilds the site live within 2 minutes

Asciidoc Demo

A very simple starter template.

Under Development Procedure Unavailable:

  1. Select Available Versions
  2. Select SUSE Manager Server 3.1 Stable
  3. WebUI Reference > Systems > All Systems
  4. Notice the Edit me button at the top of the page. Click the Edit me button
  5. You will be redirected to the Asciidoc document in the product github repository
  6. Login, make your changes, and then submit a PR "this is the doc as code process"
  7. A writer reviews PR and accepts, rejects or requests changes or more info
  8. If accepted TravisCI rebuilds the site live within a few minutes from the Asciidoc sources

A Few Important Concepts

  • Per SUSE product gh-page branches
  • Linked to suse.com/documentation as develop/stable dependent upon decision
  • Asciidoc converts directly to Docbook xml 4.5 possibly 5
  • Writers work only in Asciidoc and convert source of truth documents to docbook for publishing various outputs on suse.com in epub, pdf, and single page html.
  • If writers work in Asciidoc alone, then we never need to convert from the opposite direction docbook -> Asciidoc.
  • This requires a one time migration for latest docs. (A rather large undertaking, perhaps we can automate some of this with conversion tools)

Looking for hackers with the skills:

jekyll bootstrap docbook javascript ruby travis

This project is part of:

Hack Week 16

Activity

  • over 2 years ago: j_renner liked Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: thomas-schraitle liked Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: fsundermeyer joined Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: sven15 joined Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: JCayouette added keyword "travis" to Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: JCayouette liked Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: kwk liked Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: JCayouette started Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: JCayouette added keyword "ruby" to Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • over 2 years ago: JCayouette added keyword "jekyll" to Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
  • All Activity

    Comments

    Be the first to comment!

    Similar Projects

    All our beloved acronyms in one place... also some Jekyll hackin by thutterer

    Acronyms are fun. Everyone at SUSE loves them. ...


    OBS Project Monitor page redesign by vpereirabr

    Exactly what problem will this solve?

    Th...


    libsolv web interface by lnussel

    In order to inspect rpm dependencies inside the...


    openQA log-viewer firefox plugin by asmorodskyi

    Idea is to write FF plugin which would process ...


    SUSE Manager: Windows client support by pagarcia

    Let's see how much, if any, of the steps descri...


    Investigate options to introduce Plugins to SUSE Manager by cbosdonnat

    For years we have been discussing the idea to m...


    libsolv web interface by lnussel

    In order to inspect rpm dependencies inside the...


    Analyser for YaST logs by jreidinger

    Well, we often stuck in YaST team with knowledg...


    ActiveJob influxdb-rails instrumentation by hennevogel

    We have ActiveJob instrumentation in the OBS co...


    All our beloved acronyms in one place... also some Jekyll hackin by thutterer

    Acronyms are fun. Everyone at SUSE loves them. ...


    Learn Crystal by porting part of YaST to that language by ancorgs

    For a very long time, I have been planning to p...