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

Create ALM Integration Documentation

    XMLWordPrintable

    Details

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

      Description

      Why?

      Users generally use only one ALM. The documentation should reflect this by having the specific configuration for an ALM in its dedicated section to avoid noise and simplify configuration. 

      What?

      Documentation with clear intent (which actions/ALMs it applies to) and a flow that makes sense for users. 

      A dedicated page for each ALM should be displayed in an ALM integration section (like the CI integration section). 

      There should be one for each ALM (in order of priority) : 

      1. Github
      2. Gitlab
      3. Bitbucket
      4. Azure Devops

       Each of those sections should contain : 

      • ALM Prerequisites
      • Authentication/SSO
      • Analysis configuration
      • PR Decoration
      • ALM-specific CI Integration

      How?

      This is going to take some reworking and removing of old sections. We need to make sure links to sections that are being replaced by these Integration sections are updated. 

      We will also need to make it clear to users that they are on ALM specific documentation when they search for a concept. (For example, if they search for PR decoration, they could end up on the page for any ALM. It needs to be obvious where they are).

      We will also need to make sure the pages are SEO-friendly for people coming to the docs from a search engine.

      To avoid having the same information on multiple pages and making information hard to update, we can use the includes feature. This will allow us to reuse the same information in multiple places while avoiding having multiple places that need to be updated. 

       

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              michael.birnstiehl Mike Birnstiehl
              Reporter:
              michael.birnstiehl Mike Birnstiehl
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: