Uploaded image for project: 'Cockpit'
  1. Cockpit
  2. COCKPIT-1165

Migrate DocBook XML to a different docs format

XMLWordPrintable

    • maintainable-docs
    • 25
    • False
    • Hide

      None

      Show
      None
    • False
    • Testable
    • ?
    • In Progress
    • ?
    • rhel-cockpit
    • ?
    • 14% To Do, 43% In Progress, 43% Done

      docbook-xml is hard to write/maintain/preview, and e.g. also has been orphaned in Debian for almost a decade now. Let's investigate moving to Markdown or asciidoc.

      This concerns both the guide and the manpages (which are also rendered as part of the HTML guide).

      Markdown:

      • pro: Familiar to all of us, instant preview on GitHub
      • con: not very suitable for larger multi-file documents; there may be extensions/tools for file inclusion and building table of contents
      • pandoc has reasonable conversion from docbook to markdown, and from markdown to html/man (there are also more specialized tools)

      Asciidoc:

      Let's investigate both and pick one.

              Unassigned Unassigned
              rhn-engineering-mpitt Martin Pitt
              Aleksandra Fedorova
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: