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

Documentation links are prefixed with "/sonarqube/", making them unsuable

    XMLWordPrintable

    Details

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

      Description

      Some internal links in the embedded documentation are prefixed with /sonarqube/, making them unusable. This is due to an incorrect usage of #sonarqube-admin#, and probably a copy-paste issue. For example, src/pages/analysis/pull-request.md contains the following:

      ### Specifying Your PR Provider
      
      Specify your PR provider in your global settings at [**Administration > General Settings > Pull Requests > General > Provider**](/#sonarqube-admin#/sonarqube/admin/settings?category=pull_request/). This is the name of the system managing your PR. When using the {instance} Extension for Azure DevOps, the provider is automatically populated.
      

      That link contains a /sonarqube/ prefix after #sonarqube-admin#, which shouldn't be there. This only applies to our own instance (Next), and is already part of #sonarqube-admin# (automatic). The above example link should be written like this:

      [**Administration > General Settings > Pull Requests > General > Provider**](/#sonarqube-admin#/admin/settings?category=pull_request/)
      

      A quick search revealed several of these throughout the documentation. Simply removing /sonarqube will be enough.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              michael.birnstiehl Mike Birnstiehl
              Reporter:
              wouter.admiraal Wouter Admiraal
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: