Uploaded image for project: 'AMQ Documentation'
  1. AMQ Documentation
  2. AMQDOC-2724

Internal - Investigate auto-generation of broker.xml attributes reference doc from SW

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Done
    • Icon: Minor Minor
    • None
    • 7.0
    • Broker DOC, Internal
    • Weeks 44, 45 (Oct 30-Nov 10), Weeks 46, 47 (Nov 13-24), Weeks 12, 13 (Mar 19 - 30)

      Currently, reference documentation about every attribute in the broker.xml file is contained in appendices in the Broker Guide. This content is currently maintained manually and can become out of sync with the product very quickly: each time an attribute is added/removed, or the default value or valid values range changes, Docs depends on Eng to inform them of this change (by manually flagging a JIRA). This method is laborious and error-prone.

      Wouldn't it be cool if we could generate/update this information from auto-magically from the broker.xml file in source for each release? I don't know if this is possible, how much work it would take, other implications. However, I do know that upstream Apache Qpid Dispatch Router has a method to generate man pages from code source/doc. I think that what they do goes something like:
      schema > json file > python scripts > adoc

      This JIRA is to investigate this idea and whether it is cost-effective.

            rhn-support-pfestoso_jira Phil Festoso (Inactive)
            sjay@redhat.com Susan Jay
            Ben Hardesty, nicole.engard
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: