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

Embedded documentation shows placeholder content for superior edition languages

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 9.4
    • Component/s: Web
    • Edition:
      Community
    • Production Notes:
      None

      Description

      With SONAR-15680, we replaced all the old analyzer documentation pages with some "placeholder" content. The assumption was that this would be replaced at both run-and-build-time anyway. Except that, at run-time, we can only replace the documentation of analyzers that are actually shipping with the edition. I.e., on CE, all DE+ languages show the placeholder content. On DE, all EE+ languages show the placeholder content.

      Instead of placeholder content, we write a small section in place of the old content. This short text merely says that built-in analysis of certain languages requires upgrading to at least DE, and maybe put a link to the static language documentation on docs.sonarqube.org.

      Text template

      $LANGUAGE_NAME analysis is available starting in $EDITION Edition.

      You can read more about $LANGUAGE_NAME analysis here.

      Example:

      Apex analysis is available starting in Enterprise Edition.

      You can read more about Apex analysis here.

      Pages that require updating

      Developer Edition and above

      Path Docs link
      analysis/languages/abap.md https://docs.sonarqube.org/latest/analysis/languages/abap/
      analysis/languages/cfamily.md https://docs.sonarqube.org/latest/analysis/languages/cfamily/
      analysis/languages/plsql.md https://docs.sonarqube.org/latest/analysis/languages/plsql/
      analysis/languages/swift.md https://docs.sonarqube.org/latest/analysis/languages/swift/
      analysis/languages/tsql.md https://docs.sonarqube.org/latest/analysis/languages/tsql/

      Enterprise Edition and above

      Path Docs link
      analysis/languages/apex.md https://docs.sonarqube.org/latest/analysis/languages/apex/
      analysis/languages/cobol.md https://docs.sonarqube.org/latest/analysis/languages/cobol/
      analysis/languages/pli.md https://docs.sonarqube.org/latest/analysis/languages/pli/
      analysis/languages/rpg.md https://docs.sonarqube.org/latest/analysis/languages/rpg/
      analysis/languages/vb6.md https://docs.sonarqube.org/latest/analysis/languages/vb6/

        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

                Created:
                Updated:
                Resolved: