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

New layout for rules page

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 5.1
    • Component/s: Rules, Web
    • Labels:
      None

      Description

      As detailed on SONAR-5007, the Rules page must be designed for the following use cases:

      • "Discovering" the universe of rules by providing the ability to browse by tag, language, repository, status, characteristic, ...
        • For instance, just by entering into this Rules space, you know what are the number of available rules for the ABAP language, or having the java8 tags, or belonging to the Checkstyle repository, ... and you just have to click on those numbers to see the relating rules
      • Same "Discovery" mechanism when zooming into a Quality Profile : number of rules by tag, by repository, ... into this quality profile and ability to click on those numbers to see the relating rules in this Quality Profiles
      • Searching for rules based on some keywords - whatever the quality profile
      • Make it possible to directly open the page on a given rule so that each rule has a kind of "permalink" documentation page
      • On each rule, having the ability to know on which quality profiles this rule is activated and with which severity and parameter values
      • On each rule it should be possible to ask for the activation on a quality profile to be selected
      • When searching for rules activated on a quality profile:
        • it should be possible to search on the active severity, not the rule "built-in" severity
        • it should be straightforward to deactivate the rule or change the severity level for the selected quality profile
      • Searching for rules matching some criteria and "highlight" (not filter) the ones used in a Quality Profile. For instance, "show me the rules having the tag java8 and in this list highlight the ones activated in the Quality Profile Sonar Way".
      • Make it easy to know which new rules have been added on the instance since a given date or over a given period (see SONAR-5422)
      • Easily and quickly see if there are deprecated rules activated on some quality profiles
        • And if any, make it straigthforward to list them to take the required actions

      The current page suffers from some limitations:

      • UX/UI not consistent with other pages (mainly issues page)
      • not enough space to display rule detail
      • duplicated displayed blocks (rule names in sidebar, ...)
      • ambiguity between facets and filters
      • rule detail is complex : params/a profiles
      • rule templates/custom rules are complex to understand
      • profile administration is complex
      • permalink to single rule must be different than search and must not display search layout

        Attachments

          Issue Links

          1.
          Display facets on "Languages", "Repositories" and "Tags" SONAR-5973 Sub-task Closed OLD - Jean-Baptiste Lièvremont (Inactive) Major
          2.
          Ability to do a text search on rule descriptions and titles SONAR-5974 Sub-task Closed Stas Vilchik (Inactive) Major
          3.
          Ability to reset the pending search criteria SONAR-5975 Sub-task Closed Stas Vilchik (Inactive) Major
          4.
          Ability to create, edit and delete a "Manual" rule SONAR-5976 Sub-task Closed Stas Vilchik (Inactive) Major
          5.
          Provide a permalink on each rule description SONAR-5977 Sub-task Closed Stas Vilchik (Inactive) Major
          6.
          Ability to bulk "Activate In" or "Deactivate In" all rules matching some search criteria SONAR-5978 Sub-task Closed Stas Vilchik (Inactive) Major
          7.
          Display and edit the list of tags on each rule SONAR-5979 Sub-task Closed Stas Vilchik (Inactive) Major
          8.
          Display the SQALE properties on each rule SONAR-5980 Sub-task Closed Stas Vilchik (Inactive) Major
          9.
          Ability to extend a rule description SONAR-5981 Sub-task Closed Stas Vilchik (Inactive) Major
          10.
          Display the list of quality profiles in which the current rule is activated SONAR-5982 Sub-task Closed Stas Vilchik (Inactive) Major
          11.
          Ability to filter Rules by SQALE Characteristic/Sub-Characteristic SONAR-5983 Sub-task Closed Stas Vilchik (Inactive) Major
          12.
          Ability to filter rules by default activation severity SONAR-5984 Sub-task Closed Stas Vilchik (Inactive) Major
          13.
          Ability to filter rules by status SONAR-5985 Sub-task Closed Stas Vilchik (Inactive) Major
          14.
          Ability to filter rules by "Availability Date" SONAR-5986 Sub-task Closed Stas Vilchik (Inactive) Major
          15.
          Ability to filter rules that are actived in a quality profile SONAR-5987 Sub-task Closed Stas Vilchik (Inactive) Major
          16.
          Ability to filter rules that are inactive in a quality profile SONAR-5988 Sub-task Closed Stas Vilchik (Inactive) Major
          17.
          Ability to filter rules by "Active Severity" when the criteria "Active in QP" is used SONAR-5989 Sub-task Closed Stas Vilchik (Inactive) Major
          18.
          Ability to search rules by inheritance status (Not inherited, Overridden, Inherited) when the search criteria "Activated In Quality Profile" is used SONAR-5990 Sub-task Closed Stas Vilchik (Inactive) Major
          19.
          Ability to "Show only" or "Hide" template rules SONAR-5991 Sub-task Closed Stas Vilchik (Inactive) Major
          20.
          On "template" rules, make it possible to create "custom" rules SONAR-5992 Sub-task Closed Stas Vilchik (Inactive) Major
          21.
          Display the list of "custom" rules created from a '"template" rule SONAR-5993 Sub-task Closed Stas Vilchik (Inactive) Major
          22.
          Ability to activate a rule in a Quality Profile from the rule description SONAR-5994 Sub-task Closed Stas Vilchik (Inactive) Major
          23.
          Descriptions of rules matching search criteria should be loaded dynamically when scrolling down SONAR-6001 Sub-task Closed Stas Vilchik (Inactive) Major
          24.
          When there is no rules matching the search criteria, a "No Coding Rules" message should be displayed SONAR-6002 Sub-task Closed Stas Vilchik (Inactive) Major
          25.
          Add an activation details to the api/rules/search SONAR-6010 Sub-task Closed OLD - Jean-Baptiste Lièvremont (Inactive) Major
          26.
          Make it possible on "rules" back-end side to add in a facet a search criteria which is not part of top 10 values SONAR-6017 Sub-task Closed OLD - Jean-Baptiste Lièvremont (Inactive) Major
          27.
          The "Characteristics", "Severities" and "Status" search criteria in the "Rules" page should be facets SONAR-6019 Sub-task Closed Stas Vilchik (Inactive) Major

            Activity

              People

              Assignee:
              stas.vilchik Stas Vilchik (Inactive)
              Reporter:
              simon.brandhof Simon Brandhof (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Due:
                Created:
                Updated:
                Resolved: