Uploaded image for project: 'SonarQube'
  1. SonarQube
  2. SONAR-12384

Include documentation from bundled plugins in static docs site

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 8.0
    • Component/s: Documentation, Web
    • Labels:
      None
    • Edition:
      Community
    • Production Notes:
      None

      Description

      The static documentation must fetch the documentation shipping with the on-board plugins. This documentation is located in static/documentation.md in their respective JARs.

      At build time, this must be extracted, and stored in ./build/tmp/plugin-documentation/PLUGIN_NAME.md. The GatsbyJS build will then look into this folder to add this to the generated documentation.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              wouter.admiraal Wouter Admiraal
              Reporter:
              wouter.admiraal Wouter Admiraal
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: