docs: improve and refactor structure

[lukasmetzner]

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.46%. Comparing base (91a3dc2) to head (69a83d9). Report is 17 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #957      +/-   ##
==========================================
- Coverage   70.68%   67.46%   -3.22%     
==========================================
  Files          22       22              
  Lines        3046     3046              
==========================================
- Hits         2153     2055      -98     
- Misses        724      828     +104     
+ Partials      169      163       -6     

Flag	Coverage Δ
e2e	?
unit	67.46% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:

• :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[lukasmetzner]

I think this could be looked at for a first round of reviews.

It is probably the easiest to check out the docs folder directly. The root README.md got also updated.

[jooola]

I'd rather revert 69a83d955b1605bcedb394da8cbc6e018d362a9e, because it breaks the possibility for users to search the docs. Having it spread into multiple places makes it a bit difficult. No good idea on how to solve this elegantly.

[lukasmetzner]

I'd rather revert 69a83d9, because it breaks the possibility for users to search the docs. Having it spread into multiple places makes it a bit difficult. No good idea on how to solve this elegantly.

Idea was to parse the annotations/load-balancer.go file and automatically create the Markdown table. While building this, we could link the existing pkg.go.dev docs.

The table in https://github.com/hetznercloud/hcloud-cloud-controller-manager/commit/69a83d955b1605bcedb394da8cbc6e018d362a9e was not really that great, as it contained the constant names, rather than the actual annotations you would use on a load balancer.