search

caas-team / sparrow

A monitoring tool to gather infrastructure network information
Apache License 2.0
6 stars 4 forks source link

docs: prepare v0.3.0 release #76

Closed lvlcn-t closed 8 months ago

lvlcn-t commented 8 months ago

Motivation

To adjust our docs to the new check configurations.

Changes

I've adjusted the health and latency documentation in the readme and added a link to the readme docs to the helm values for the checkConfig.

For additional information look at the commits.

Tests done

None needed.

Pre-commit passed.

TODO

y-eight commented 8 months ago

As I mentioned in https://github.com/caas-team/sparrow/pull/75

I would like to correct the docu for the Helm part in the main README as well. I will add it to this PR if you don't mind.

lvlcn-t commented 8 months ago

@puffitos @y-eight I've updated and rephrased some sections of the readme again to improve clarity and readability a little bit to make the content more direct and user-friendly.

I've made the installation instructions more clear, refined the explanation of the Target Manager, and ensured consistent and concise language throughout.

Can you look over my new commits again to improve possible grammar errors, typos etc?