Skip to content

Commit 606bf7d

Browse files
committed
spelling
Signed-off-by: Gregor Zeitlinger <[email protected]>
1 parent c07e430 commit 606bf7d

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Docs
22

3-
This directory contains [hugo](https://gohugo.io) documentation to be published in Github pages.
3+
This directory contains [hugo](https://gohugo.io) documentation to be published in GitHub pages.
44

55
## Run Locally
66

@@ -10,14 +10,14 @@ hugo server -D
1010

1111
This will serve the docs on [http://localhost:1313](http://localhost:1313).
1212

13-
## Deploy to Github Pages
13+
## Deploy to GitHub Pages
1414

15-
Changes to the `main` branch will be deployed automatically with Github actions.
15+
Changes to the `main` branch will be deployed automatically with GitHub actions.
1616

1717
## Update Javadoc
1818

19-
Javadoc are not checked-in to the Github repository.
20-
They are generated on the fly by Github actions when the docs are updated.
19+
Javadoc are not checked-in to the GitHub repository.
20+
They are generated on the fly by GitHub actions when the docs are updated.
2121
To view locally, run the following:
2222

2323
```
@@ -27,7 +27,7 @@ rm -r ./docs/static/api
2727
mv ./target/site/apidocs ./docs/static/api
2828
```
2929

30-
Github pages are in the `/client_java/` folder, so we link to `/client_java/api` rather than `/api`.
30+
GitHub pages are in the `/client_java/` folder, so we link to `/client_java/api` rather than `/api`.
3131
To make JavaDoc work locally, create a link:
3232

3333
```
@@ -37,7 +37,7 @@ ln -s ../api ./docs/static/client_java/api
3737

3838
## Update Geekdocs
3939

40-
The docs use the [Geekdocs](https://geekdocs.de/) theme. The theme is checked in to Github in the
40+
The docs use the [Geekdocs](https://geekdocs.de/) theme. The theme is checked in to GitHub in the
4141
`./docs/themes/hugo-geekdoc/` folder. To update [Geekdocs](https://geekdocs.de/), remove the current
4242
folder and create a new one with the
4343
latest [release](https://github.com/thegeeklab/hugo-geekdoc/releases). There are no local

docs/content/getting-started/registry.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Counter eventsTotal = Counter.builder()
5151
PrometheusRegistry.defaultRegistry.register(eventsTotal);
5252

5353
// register the counter with a custom registry.
54-
// This is ok, you can register a metric with multiple registries.
54+
// This is OK, you can register a metric with multiple registries.
5555

5656
PrometheusRegistry myRegistry = new PrometheusRegistry();
5757
myRegistry.register(eventsTotal);
@@ -62,7 +62,7 @@ a debug registry with a lot of metrics, and a default registry with only a few m
6262

6363
## IllegalArgumentException: Duplicate Metric Name in Registry
6464

65-
While it is ok to register the same metric with multiple registries, it is illegal to register the
65+
While it is OK to register the same metric with multiple registries, it is illegal to register the
6666
same metric name multiple times with the same registry.
6767
The following code will throw an `IllegalArgumentException`:
6868

docs/content/internals/model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ method.
2929
There is no need for users to use `prometheus-metrics-model` directly. Users should use the API
3030
provided by `prometheus-metrics-core`, which includes the core metrics as well as callback metrics.
3131

32-
However, maintainers of 3rd party metrics libraries might want to use `prometheus-metrics-model` if
32+
However, maintainers of third-party metrics libraries might want to use `prometheus-metrics-model` if
3333
they want to add Prometheus exposition formats to their metrics library.
3434

3535
## Exporters and exposition formats

docs/content/migration/simpleclient.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Simpleclient
33
weight: 1
44
---
55

6-
The Prometheus Java client library 1.0.0 is a complete rewrite of the underlying data model, and is not backwards
6+
The Prometheus Java client library 1.0.0 is a complete rewrite of the underlying data model, and is not backward
77
compatible with releases 0.16.0 and older for a variety of reasons:
88

99
- The old data model was based on [OpenMetrics](https://openmetrics.io). Native histograms don't fit with the

docs/content/otel/tracing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,4 +69,4 @@ policies:
6969
The [examples/example-exemplar-tail-sampling/](https://github.com/prometheus/client_java/tree/main/examples/example-exemplars-tail-sampling)
7070
directory has a complete end-to-end example, with a distributed Java application with two services,
7171
an OpenTelemetry collector, Prometheus, Tempo as a trace database, and Grafana dashboards. Use
72-
docker-compose as described in the example's README to run the example and explore the results.
72+
docker-compose as described in the example's readme to run the example and explore the results.

examples/example-exemplars-tail-sampling/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ With _head-based sampling_ this works out-of-the-box: The Prometheus client libr
6060
`Span.current().getSpanContext().isSampled()` function and selects Exemplars only if the current Span is sampled.
6161

6262
With _tail-based sampling_ there is a trick: The Prometheus client library adds an attribute `exemplar="true"` to each
63-
Span that is used as an Exemplar. The remainder of this README shows how you can configure the `tail_sampling` processor
63+
Span that is used as an Exemplar. The remainder of this readme shows how you can configure the `tail_sampling` processor
6464
of the OpenTelemetry collector to sample Spans marked with `exemplar="true"`.
6565

6666
## Build the Example

examples/example-native-histogram/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This will run the following Docker containers:
2525
- [http://localhost:9090](http://localhost:9090) Prometheus server
2626
- [http://localhost:3000](http://localhost:3000) Grafana (user _admin_, password _admin_)
2727

28-
You might need to replace `localhost` with `host.docker.internal` on MacOS or Windows.
28+
You might need to replace `localhost` with `host.docker.internal` on macOS or Windows.
2929

3030
The Grafana server is preconfigured with two dashboards, one based on the classic histogram and the other one based on
3131
the native histogram.

simpleclient-archive/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
This is not functional source code. We just keep these files around so we don't loose the Github history once we copy them to the new 1.0.x modules.
1+
This is not functional source code. We just keep these files around so we don't loose the GitHub history once we copy them to the new 1.0.x modules.
22

33
If you are looking for the source code for the latest 0.x.x release, see the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) branch.

0 commit comments

Comments
 (0)