docs: more best practices

[kostis-codefresh]

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
• The title of the PR is (a) conventional with a list of types and scopes found here, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
• I've signed my commits with DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My builds are green. Try syncing with master if they are not.
• My organization is added to USERS.md.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[github-actions]

Go Published Test Results

2 144 tests   2 144 ✅  2m 51s ⏱️
  119 suites      0 💤
    1 files        0 ❌

Results for commit aa30f5e.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.80%. Comparing base (8405f2e) to head (aa30f5e).
Report is 61 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3484      +/-   ##
==========================================
+ Coverage   81.83%   82.80%   +0.96%     
==========================================
  Files         135      135              
  Lines       20688    17032    -3656     
==========================================
- Hits        16931    14104    -2827     
+ Misses       2883     2038     -845     
- Partials      874      890      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[github-actions]

E2E Tests Published Test Results

  4 files    4 suites   3h 46m 48s ⏱️
110 tests 100 ✅  6 💤  4 ❌
450 runs  416 ✅ 24 💤 10 ❌

For more details on these failures, see this check.

Results for commit aa30f5e.