Added more comprehensive docstrings to values, using helm-docs tool

[rosesyrett]

Added extra descriptions in the helm documentation for the values.yaml file. Auto generated a README in the helm repository containing this information in a table.

Perhaps we should setup a CI job to do this, as part of this PR? I think this should also be done for the nexus-filewriting-service.

[rosesyrett]

Note: on github currently the README looks a little squished and I'm not sure the best way of fixing this... https://github.com/DiamondLightSource/blueapi/tree/helm-docs/helm/blueapi

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.33%. Comparing base (d1b283b) to head (cff51a5).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #346   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files          35       35           
  Lines        1800     1800           
=======================================
  Hits         1662     1662           
  Misses        138      138           

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

[stan-dot]

re: inclusion in the CI - this is important for Developer Experience

there is a list of possible actions for running helm-docs, though all seem not maintained as much:

• https://github.com/marketplace/actions/setup-helm-docs
• https://github.com/losisin/helm-docs-github-action
• https://github.com/marketplace/actions/helm-docs-github-action
• https://github.com/marketplace/actions/helm-docs-gh-actions

[callumforrester]

Fixes #660

@stan-dot feel free to experiment

[DiamondJoseph]

For a lot of these, it may be worth re-running helm create and seeing what comments are present, stick with what is readily available if sufficient and not roll our own.