Skip to content

Commit 97d1177

Browse files
committed
Reduce duplicated text. Most details should be on individual pages & Sonar has a link
1 parent 8810c34 commit 97d1177

File tree

2 files changed

+4
-12
lines changed

2 files changed

+4
-12
lines changed

doc/user_guide/features/metrics/collecting_metrics.rst

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -52,20 +52,12 @@ Currently, the PTB offers two methods to aggregate the :ref:`direct_metrics`
5252
into a report:
5353

5454
#. the nox session ``project:report``
55-
This summarization tool can generate either a JSON or markdown summary where
56-
it provides an overall coverage percentage, maintainability grade, and security
57-
grade. The generated JSON follows a code-agnostic format which can be used
58-
for code quality analysis across Exasol. The markdown summary can be displayed in
59-
the GitHub Action's Summary for a given CI run. For more information, see :ref:`project_report`.
55+
This is an Exasol-specific summarization tool. For more information, see :ref:`project_report`.
6056

6157
#. SonarQube analysis
6258
This summarization tool feeds into a feature-rich UI provided by
63-
`Sonar <https://docs.sonarsource.com/sonarqube-server/latest/>`__. The total coverage
64-
is calculated as a percentage and visually displayed per line on the altered code.
65-
Security & linting issues are displayed in a list with links to the code & textual
66-
descriptions on why they should be fixed and how they can be fixed. Additionally,
67-
this information can be paired per project with a bot, which reports the code
68-
quality analysis results within a PR. For further details, see :ref:`sonarqube_analysis`
59+
`Sonar <https://docs.sonarsource.com/sonarqube-server/latest/>`__. For further
60+
details, see :ref:`sonarqube_analysis`
6961

7062
Both of these reporting options require that the generated files from the :ref:`direct_metrics`
7163
are existing and in the expected formats. As we have metrics for different Python

doc/user_guide/features/metrics/sonar.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The PTB supports using SonarQube Cloud to analyze, visualize, & track linting, s
88
and subscribe to the
99
`Clean as You Code <https://docs.sonarsource.com/sonarqube-server/9.8/user-guide/clean-as-you-code/>`__
1010
methodology. If code modified in a PR does not satisfy the aforementioned criteria, we
11-
will receiving a failing (red) SonarQube analysis.
11+
will receive a failing (red) SonarQube analysis.
1212

1313
Additionally, per project, we enact a GitHub bot (differs based on :ref:`configuration`,
1414
which reports the status of the Sonar analysis into a PR as a stylized comment and as

0 commit comments

Comments
 (0)