Skip to content

Commit a2d1ea8

Browse files
ArBridgemanckunki
andauthored
Documentation/510 consolidate metrics and sonar (#511)
* Start to add onto collecting metrics & add files for reporting metrics * Move and try to reformat/reduce metrics.rst to project_report.rst * Remove empty nox.rst and nothing-to-see-here.png as no longer used * Move sonar configuration to sonar file * Fix links * update text to be more direct with PTB as actor per review Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com> * reduce words & use proper nouns to make intent clearer per review Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com> * be more explicit that GitHub repository, not just project, per review Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com> * be more explicit that GitHub repository, not just project, per review Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com> * Switch one .lint.json to .lint.txt * Fix underline issue from review comments * Switch to paragraph form for instructions so clearer who is actor & where * Reduce duplicated text. Most details should be on individual pages & Sonar has a link * Switch from direct to generated metrics * Switch text to be a bit shorter & still accurate * Remove length text and use passive to avoid other issues * Switch to passive text * Switch we with fact statement with are * Alter text to be clearer what we do per review Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com> * Fix typo * Apply changes per review --------- Co-authored-by: Christoph Kuhnke <christoph.kuhnke@exasol.com>
1 parent bb6027d commit a2d1ea8

File tree

15 files changed

+246
-241
lines changed

15 files changed

+246
-241
lines changed

doc/_static/metrics-artifact.png

-68.9 KB
Binary file not shown.
-86.2 KB
Binary file not shown.
-475 KB
Binary file not shown.

doc/changes/unreleased.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
## Documentation
44

55
* #512: Consolidated and added to deploying documentation pages
6+
* #510: Consolidated information of metrics & updated to include more about Sonar

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,4 +90,5 @@
9090
# the canonical URI will be treated as "working".
9191
r"https://github\.com/.*": r"https://github\.com/login*",
9292
r"https://www.sphinx-doc\.org/.*": r"https://www.sphinx-doc\.org/en/master/.*",
93+
r"https://sonarcloud\.io.*": r"https://www.sonarsource\.com/products/sonarcloud/.*",
9394
}

doc/developer_guide/modules/modules.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@ Modules
44
.. toctree::
55
:maxdepth: 2
66

7-
nox
87
nox_tasks

doc/developer_guide/modules/nox.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

doc/index.rst

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,11 @@ Documentation of the Exasol-Toolbox
3737

3838
Document outlining the architectural and design principles and decisions in this project.
3939

40-
.. grid-item-card:: :octicon:`graph` Metrics
41-
:link: metrics
42-
:link-type: ref
43-
44-
Details on metrics collection and support related to and supported by the Python toolbox.
45-
4640
.. grid-item-card:: :octicon:`question` FAQ
4741
:link: faq_toolbox
4842
:link-type: ref
4943

50-
Frequently asked questsions.
44+
Frequently asked questions.
5145

5246

5347
.. toctree::
@@ -58,6 +52,5 @@ Documentation of the Exasol-Toolbox
5852
developer_guide/developer_guide
5953
tools
6054
github_actions/github_actions
61-
metrics
6255
faq
6356
changes/changelog

doc/metrics.rst

Lines changed: 0 additions & 123 deletions
This file was deleted.

doc/user_guide/features/collecting_metrics.rst

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)