Skip to content

Commit

Permalink
docs: resolve various typos
Browse files Browse the repository at this point in the history
  • Loading branch information
tboerger committed Oct 23, 2024
1 parent 4a961af commit e937c75
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ cd prometheus-vcd-sd/
{{< / highlight >}}

All required tool besides Go itself are bundled, all you need is part of the
`Makfile`:
`Makefile`:

{{< highlight txt >}}
make generate build
Expand Down
8 changes: 4 additions & 4 deletions docs/content/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,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.

Expand Down Expand Up @@ -195,7 +195,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
Expand All @@ -209,8 +209,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
Expand Down

0 comments on commit e937c75

Please sign in to comment.