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

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

  • Comments

    Be the first to comment!

    Similar Projects

    obs-service-vendor_node_modules by cdimonaco

    Description

    When building a javascript package for obs, one option is to use https://github.com/openSUSE/obs-service-node_modules as source service to get the project npm dependencies available for package bulding.

    obs-service-vendornodemodules aims to be a source service that vendors npm dependencies, installing them with npm install (optionally only production ones) and then creating a tar package of the installed dependencies.

    The tar will be used as source in the package building definitions.

    Goals

    • Create an obs service package that vendors the npm dependencies as tar archive.
    • Maybe add some macros to unpack the vendor package in the specfiles

    Resources


    Editor mode at Agama web interface by ancorgs

    Description

    Agama is a new Linux installer that will be very likely used for SLES 16.

    It takes a configuration (in JSON format) as input. And offers several interfaces to build that configuration in an easy and interactive way.

    I was considering the possibility to add to the web interface a "text editor" mode similar to the XML editor available at virt-manager. That could be used to see how the changes in the UI translate into changes on the configuration.

    Goals

    • Refresh my knowledge about UI development for Agama, since there was a major overhaul recently (adopting TanStack Query) and I need to learn the new way to do things.
    • Please hackers who always want to know how things work internally. :-)


    Agama installer on-line demo by lslezak

    Description

    The Agama installer provides a quite complex user interface. We have some screenshots on the web page but as it is basically a web application it would be nice to have some on-line demo where users could click and check it live.

    The problem is that the Agama server directly accesses the hardware (storage probing) and loads installation repositories. We cannot easily mock this in the on-line demo so the easiest way is to have just a read-only demo. You could explore the configuration options but you could not change anything, all changes would be ignored.

    The read-only demo would be a bit limited but I still think it would be useful for potential users get the feeling of the new Agama installer and get familiar with it before using in a real installation.

    As a proof of concept I already created this on-line demo.

    The implementation basically builds Agama in two modes - recording mode where it saves all REST API responses and replay mode where it for the REST API requests returns the previously recorded responses. Recording in the browser is inconvenient and error prone, there should be some scripting instead (see below).

    Goals

    • Create an Agama on-line demo which can be easily tested by users
    • The Agama installer is still in alpha phase and in active development, the online demo needs to be easily rebuilt with the latest Agama version
    • Ideally there should be some automation so the demo page is rebuilt automatically without any developer interactions (once a day or week?)

    TODO

    • Use OpenAPI to get all Agama REST API endpoints, write a script which queries all the endpoints automatically and saves the collected data to a file (see this related PR).
    • Write a script for starting an Agama VM (use libvirt/qemu?), the script should ensure we always use the same virtual HW so if we need to dump the latest REST API state we get the same (or very similar data). This should ensure the demo page does not change much regarding the storage proposal etc...
    • Fix changing the product, currently it gets stuck after clicking the "Select" button.
    • Move the mocking data (the recorded REST API responses) outside the Agama sources, it's too big and will be probably often updated. To avoid messing the history keep it in a separate GitHub repository
    • Allow changing the UI language
    • Display some note (watermark) in the page so it is clear it is a read-only demo (probably with some version or build date to know how old it is)
    • Automation for building new demo page from the latest sources. There should be some check which ensures the recorded data still matches the OpenAPI specification.

    Changing the UI language

    This will be quite tricky because selecting the proper translation file is done on the server side. We would probably need to completely re-implement the logic in the browser side and adapt the server for that.

    Also some REST API responses contain translated texts (storage proposal, pattern names in software). We would need to query the respective endpoints in all supported languages and return the correct response in runtime according to the currently selected language.

    Resources


    Agama Expert Partitioner by joseivanlopez

    Description

    Agama is a new Linux installer that will be very likely used for SLES 16.

    It offers an UI for configuring the target system (language, patterns, network, etc). One of the more complex sections is the storage configuration, which is going to be revamped. This project consists on exploring the possibility of having something similar to the YaST Expert Partitioner for Agama.

    Goals

    • Explore different approaches for the storage UI in Agama.


    Try to render Agama in a TUI browser by ancorgs

    Description

    Agama is a new Linux installer that will be very likely used for SLES 16. It offers a modern and convenient web interface that can be executed both locally and remotely.

    But of course some users will miss the old TUI (ncurses) interface of the YaST installer.

    So I want to experiment whether would it be possible to render a simplified version of the web interface for TUI browsers. That's only doable and maintainable if we keep the current technology stack we use for rendering the full-blown page, simply replacing complicated UI elements with others that are easy to render. That means the browser would need to support Javascript.

    Chawan seems to be almost there regarding support for Javascript, XHR and related technologies. But according to this conversation, the next missing piece would be to support recursive import of module script tags.

    Unfortunately, Chawan is written in Nim and I'm pretty sure a week is not enough time for me to learn Nim, implement the feature at Chawan and then fix whatever is the next obstacle on the Agama side.

    But if someone could take care of the Nim part, I would do the same with the Agama one. So this is basically a call for help to get this project even started.


    Recipes catalog and calculator in Rails 8 by gfilippetti

    My wife needs a website to catalog and sell the products of her upcoming bakery, and I need to learn and practice modern Rails. So I'm using this Hack Week to build a modern store using the latest Ruby on Rails best practices, ideally up to the deployment.

    TO DO

    • Index page
    • Product page
    • Admin area -- Supplies calculator based on orders -- Orders notification
    • Authentication
    • Payment
    • Deployment

    Day 1

    As my Rails knowledge was pretty outdated and I had 0 experience with Turbo (wich I want to use in the app), I started following a turbo-rails course. I completed 5 of 11 chapters.

    Day 2

    Continued the course until chapter 8 and added live updates & an empty state to the app. I should finish the course on day 3 and start my own project with the knowledge from it.

    Hackweek 24

    For this Hackweek I'll continue this project, focusing on a Catalog/Calculator for my wife's recipes so she can use for her Café.

    Day 1


    Fix RSpec tests in order to replace the ruby-ldap rubygem in OBS by enavarro_suse

    Description

    "LDAP mode is not official supported by OBS!". See: config/options.yml.example#L100-L102

    However, there is an RSpec file which tests LDAP mode in OBS. These tests use the ruby-ldap rubygem, mocking the results returned by a LDAP server.

    The ruby-ldap rubygem seems no longer maintaned, and also prevents from updating to a more recent Ruby version. A good alternative is to replace it with the net-ldap rubygem.

    Before replacing the ruby-ldap rubygem, we should modify the tests so the don't mock the responses of a LDAP server. Instead, we should modify the tests and run them against a real LDAP server.

    Goals

    Goals of this project:

    • Modify the RSpec tests and run them against a real LDAP server
    • Replace the net-ldap rubygem with the ruby-ldap rubygem

    Achieving the above mentioned goals will:

    • Permit upgrading OBS from Ruby 3.1 to Ruby 3.2
    • Make a step towards officially supporting LDAP in OBS.

    Resources