Uploaded image for project: 'OpenNMS'
  1. OpenNMS
  2. NMS-9495

Use the AsciiBinder framework to content management and publishing

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Security Level: Default (Default Security Scheme)
    • Labels:
      None
    • Epic Name:
      Migrate documentation from pure AsciiDoctor to AsciiBinder

      Description

      The current setup has some issues regarding usability. While the content is getting larger, the rendering to a single static page becomes hard to use. Publishing and distributing versions of the documentation to https://docs.opennms.org requires external tools.

      The AsciiBinder is a new framework which addresses the following topics:

      • Allows content managers to build and publish several variants of the same documentation
      • Makes it easier for developers and community members to contribute documentation
      • Support for multiple versions of the documentation using Git
      • Publishing and maintain large sets of documentation written in AsciiDoc format

      The AsciiBinder framework is maintained currently under Red Hat and is successfully used in OpenShift, Project Atomic and ManageIQ. One of the AsciiBinder maintainers is also proposing AsciiBinder as the framework in the Fedora Project.

      Resources

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              indigo Ronny Trommer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: