From 6c1bbec6692635ccb44c8e78f69b6ce363f3f051 Mon Sep 17 00:00:00 2001 From: Thomas Boerger Date: Wed, 23 Oct 2024 20:14:57 +0200 Subject: [PATCH] docs: resolve various typos --- CONTRIBUTING.md | 4 ++-- docs/content/building.md | 2 +- docs/content/usage.md | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 007768a..b849a3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ getting free help. We are using Github Issues for submitting known issues, e.g. bugs, features, etc. Some issues will have someone assigned, meaning that there's already -someone that takes responsability for fixing said issue. This is not done to +someone that takes responsibility for fixing said issue. This is not done to discourage contributions, rather to not step in the work that has already been done by the assignee. If you want to work on a known issue with someone already assigned to it, please consider contacting the assignee first, e.g. by @@ -50,7 +50,7 @@ maintain your code after it gets merged. ## Mind the Style We believe that in order to have a healthy codebase we need to abide to a -certain code style. We use `gofmt` with Go and `eslint` with Javscript for this +certain code style. We use `gofmt` with Go and `eslint` with Javascript for this matter, which are tools that has proved to be useful. So, before submitting your pull request, make sure that `gofmt` and if viable `eslint` are passing for you. diff --git a/docs/content/building.md b/docs/content/building.md index c33112c..8e8d4d6 100644 --- a/docs/content/building.md +++ b/docs/content/building.md @@ -16,7 +16,7 @@ cd prometheus-hcloud-sd/ {{< / highlight >}} All required tool besides Go itself are bundled, all you need is part of the -`Makfile`: +`Makefile`: {{< highlight txt >}} make generate build diff --git a/docs/content/usage.md b/docs/content/usage.md index 813b789..09934a1 100644 --- a/docs/content/usage.md +++ b/docs/content/usage.md @@ -42,7 +42,7 @@ scrape_configs: After preparing the configuration we need to create the `docker-compose.yml` within the same folder, this `docker-compose.yml` starts a simple [Prometheus][prometheus] instance together with the service discovery. Don't -forget to update the envrionment variables with the required credentials. If you +forget to update the environment variables with the required credentials. If you are using a different volume for the service discovery you have to make sure that the container user is allowed to write to this volume. @@ -178,7 +178,7 @@ running. You can access [Prometheus][prometheus] at ## Configuration -### Envrionment variables +### Environment variables If you prefer to configure the service with environment variables you can see the available variables below, in case you want to configure multiple accounts @@ -192,8 +192,8 @@ by the variables, it's up to you. ### Web Configuration If you want to secure the service by TLS or by some basic authentication you can -provide a `YAML` configuration file whch follows the [Prometheus][prometheus] -toolkit format. You can see a full configration example within the +provide a `YAML` configuration file which follows the [Prometheus][prometheus] +toolkit format. You can see a full configuration example within the [toolkit documentation][toolkit]. ### Configuration file