Improve documentation and quickstart #6
Conversation
README.md
Outdated
| version. Currently, this exporter has been tested with versions 19.5 and 20. | ||
|
|
||
| The available Docker compose configuration expects these binaries to be | ||
| installed in the `./hfs-bin/` directory, but you can use the directory of your |
There was a problem hiding this comment.
Can you precise the way to choose the directory?
There was a problem hiding this comment.
There might be a bit of complexity between the docker-compose and the config.yml file that will be interpreted from inside the container that could be worth explaining 👍
There was a problem hiding this comment.
I fixed that in 84eb035, hopefully this is better.
|
I wonder if it is for this MR or we should have a dedicated one but it could be interesting to mention in the documentation that this can also be installed as a python package. It's a cool feature that could interest the non docker crowd. What do you think ? |
I feel like it's fairly unlikely to be used like this, knowing the general recommended use case of prometheus exporters. And so any way to make the documentation a bit leaner is an added bonus. |
No description provided.