Uploaded image for project: 'JBeret'
  1. JBeret
  2. JBERET-284

Configure miredot plugin to improve the look-and-feel of rest docs

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Done
    • Minor
    • 1.3.0.Beta5
    • 1.3.0.Beta3
    • docs, jberet-rest-api
    • None

    Description

      current jberet-rest-api REST docs are generated with miredot plugin with pretty much the default configuration.

      http://docs.jboss.org/jberet/latest/rest-doc/

      Need to configure the miredot plugin to improve the appearance of the generated REST docs. For instance:

      • to instruct miredot to ignore certain issues like missing authors, etc;
      • to have a more natural title as opposed to the default value (jberet-rest-api-1.3.0.Beta3)
      • other similar issues.

      See http://www.miredot.com/docs/manual/ for more details.

      Note that we currently use <version.miredot>2.0</version.miredot>.
      Miredot was updated to 2.0.2 on 12/20/2016: https://github.com/jberet/jsr352/commit/100ee7a5f16251dffce08574e98d89e64fd57e97

      miredot plugin configuration is in JBeret root pom.xml
      Miredot plugin configuration was moved to jberet-rest-api pom.xml on 12/29/2016: https://github.com/jberet/jsr352/commit/77a3d28b9bf4fdc434652965ff124645008d9380

      Attachments

        Issue Links

          Activity

            People

              cfang@redhat.com Cheng Fang
              cfang@redhat.com Cheng Fang
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: