Research/Development: `Doc as Code` Using Asciidoctor, Jekyll, gh-pages, TravisCI, Bootstrap v4 and any Additional Tech Discovered Along the Way
a project by JCayouette
Updated over 3 years ago. 4 hacker ♥️.

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)

Join this project

Looking for hackers with the skills:

jekyll bootstrap docbook javascript ruby travis

This project is part of:

Hack Week 16

Activity

  • almost 8 years ago: j_renner liked this project.
  • almost 8 years ago: thomas-schraitle liked this project.
  • almost 8 years ago: fsundermeyer joined this project.
  • almost 8 years ago: sven15 joined this project.
  • almost 8 years ago: JCayouette added keyword "travis" to this project.
  • almost 8 years ago: JCayouette liked this project.
  • almost 8 years ago: kwk liked this project.
  • almost 8 years ago: JCayouette started this project.
  • almost 8 years ago: JCayouette added keyword "ruby" to this project.
  • almost 8 years ago: JCayouette added keyword "jekyll" to this project.
  • almost 8 years ago: JCayouette added keyword "bootstrap" to this project.
  • almost 8 years ago: JCayouette added keyword "docbook" to this project.
  • almost 8 years ago: JCayouette added keyword "javascript" to this project.
  • almost 8 years ago: JCayouette originated this project.


    • Comments

    Be the first to comment!

    Similar Projects

    Kudos aka openSUSE Recognition Platform by lkocman

    Description

    I started the Kudos application shortly after Leap 16.0 to create a simple, friendly way to recognize people for their work and contributions to openSUSE. There’s so much more to our community than just submitting requests in OBS or gitea we have translations (not only in Weblate), wiki edits, forum and social media moderation, infrastructure maintenance, booth participation, talks, manual testing, openQA test suites, and more!

    Goals

    • Kudos under github.com/openSUSE/kudos with build previews aka netlify

    • Have a kudos.opensuse.org instance running in production

    • Build an easy-to-contribute recognition platform for the openSUSE communit a place where everyone can send and receive appreciation for their work, across all areas of contribution.

    • In the future, we could even explore reward options such as vouchers for t-shirts or other community swag, small tokens of appreciation to make recognition more tangible.

    Resources