Update documentation with exclusion & add summary to unreleased

Author: ArBridgeman

doc/changes/unreleased.md

@@ -1,5 +1,18 @@
 # Unreleased
 
+## Summary
+
+This version of the PTB resolves many bugfixes associated with the cookiecutter template
+and creating a new project that uses the PTB.
+
+If any directories or files specified in your `noxconfig.py` via `Config.source` should
+not be included in a Sonar analysis, it is recommended to add the following to
+your `pyproject.toml` under the `[tool.sonar]` section:
+
+```toml
+exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
+```
+
 ## Bugfixes
 
 * #489: Fixed .pre-commit-config.yaml to use existing nox tasks

doc/user_guide/getting_started.rst

@@ -229,6 +229,7 @@ For a **public** project
         projectKey = "com.exasol:<project-key>"
         hostUrl = "https://sonarcloud.io"
         organization = "exasol"
+        exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
 6. Post-merge, update the branch protections to include SonarQube analysis
 
   * This should only be done when tests exist for the project, & that the project is
@@ -253,8 +254,15 @@ For a **private** project
         projectKey = "com.exasol:<project-key>"
         hostUrl = "https://sonar.exasol.com"
         organization = "exasol"
+        exclusions = "<source-directory>/version.py,<source_directory>/<directory-to-ignore>/*"
 6. Post-merge, update the branch protections to include SonarQube analysis from exasonarqubeprchecks
 
+  * This should only be done when tests exist for the project, & that the project is
+    at a state in which enforced code coverage would not be a burden. For new projects,
+    we recommend creating an issue to add the SonarQube analysis to the branch protections
+    at a later point. In such scenarios, SonarQube analysis will still report its analysis
+    results to the PR, but it will not prevent the PR from being merged.
+
 9. Go 🥜
 +++++++++++++
 You are ready to use the toolbox. With *nox -l* you can list all available tasks.