Qpid Proton
  1. Qpid Proton
  2. PROTON-280

Maven should generate project documentation including markdown docs

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.5
    • Component/s: None
    • Labels:
      None

      Description

      Maven can generate a web site from a project. We should configure this to include the markdown documents added recently in docs.

        Activity

        Hide
        Philip Harvey added a comment -

        Use the standard Maven commands to generate documentation for the top-level project and its sub-modules. For the uninitiated, this should be something like:

        mvn package site site:stage

        This generates a web site in proton/target/staging/

        Show
        Philip Harvey added a comment - Use the standard Maven commands to generate documentation for the top-level project and its sub-modules. For the uninitiated, this should be something like: mvn package site site:stage This generates a web site in proton/target/staging/
        Hide
        Philip Harvey added a comment -

        committed in revision 1463950

        Show
        Philip Harvey added a comment - committed in revision 1463950

          People

          • Assignee:
            Philip Harvey
            Reporter:
            Philip Harvey
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development