lint

Signed-off-by: Gregor Zeitlinger <[email protected]>

Author: zeitlinger

docs/content/_index.md

@@ -2,7 +2,9 @@
 title: "client_java"
 ---
 
-This is the documentation for the [Prometheus Java client library](https://github.com/prometheus/client_java) version 1.0.0 and higher.
+This is the documentation for the 
+[Prometheus Java client library](https://github.com/prometheus/client_java) 
+version 1.0.0 and higher.
 
 The main new features of the 1.0.0 release are:
 
@@ -28,7 +30,7 @@ synchronization. See Javadoc comments in
 **More Info**
 
 The Grafana Labs Blog has a post
-[Introducing the Prometheus Java Client 1.0.0](https://grafana.com/blog/2023/09/27/introducing-the-prometheus-java-client-1.0.0/)
+[Introducing the Prometheus Java Client 1.0.0](https://grafana.com/blog/2023/09/27/introducing-the-prometheus-java-client-1.0.0/) <!-- editorconfig-checker-disable-line -->
 with a good overview of the release.
 
 There will also be a presentation at the [PromCon](https://promcon.io) conference on 29 Sep 2023.
@@ -41,9 +43,12 @@ Updating to the 1.0.0 version is a breaking change. However, there's a
 `prometheus-metrics-simpleclient-bridge` module available that allows you to use your existing
 simpleclient 0.16.0 metrics with the new 1.0.0 `PrometheusRegistry`.
 So you don't need to upgrade your instrumentation code, you can keep using your existing metrics.
-See the [compatibility > simpleclient](https://prometheus.github.io/client_java/migration/simpleclient/) in the menu on the left.
+See the 
+[compatibility > simpleclient](https://prometheus.github.io/client_java/migration/simpleclient/) 
+in the menu on the left.
 
-The pre 1.0.0 code is now maintained on the [simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) feature branch.
+The pre 1.0.0 code is now maintained on the 
+[simpleclient](https://github.com/prometheus/client_java/tree/simpleclient) feature branch.
 
 Not all `simpleclient` modules from 0.16.0 are included in the initial 1.0.0 release.
 Over the next couple of weeks we will work on porting the remaining modules,

docs/content/config/config.md

@@ -36,6 +36,7 @@ The properties file is searched in the following locations:
 
 ## Metrics Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                                      | Javadoc                                                                                                                                                                         | Note    |
 | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
 | io.prometheus.metrics.exemplarsEnabled                    | [Counter.Builder.withExemplars()](</client_java/api/io/prometheus/metrics/core/metrics/Counter.Builder.html#withExemplars()>)                                                   | (1) (2) |
@@ -51,6 +52,7 @@ The properties file is searched in the following locations:
 | io.prometheus.metrics.summaryQuantileErrors               | [Summary.Builder.quantile(double, double)](</client_java/api/io/prometheus/metrics/core/metrics/Summary.Builder.html#quantile(double,double)>)                                  | (5)     |
 | io.prometheus.metrics.summaryMaxAgeSeconds                | [Summary.Builder.maxAgeSeconds()](</client_java/api/io/prometheus/metrics/core/metrics/Summary.Builder.html#maxAgeSeconds(long)>)                                               |         |
 | io.prometheus.metrics.summaryNumberOfAgeBuckets           | [Summary.Builder.numberOfAgeBuckets()](</client_java/api/io/prometheus/metrics/core/metrics/Summary.Builder.html#numberOfAgeBuckets(int)>)                                      |         |
+<!-- editorconfig-checker-enable -->
 
 **Notes**
 
@@ -82,29 +84,35 @@ This works for all Metrics properties.
 
 ## Exemplar Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                               | Javadoc                                                                                                                                                         | Note |
 | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exemplars.minRetentionPeriodSeconds  | [ExemplarsProperties.getMinRetentionPeriodSeconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getMinRetentionPeriodSeconds()>)   |      |
 | io.prometheus.exemplars.maxRetentionPeriodSeconds  | [ExemplarsProperties.getMaxRetentionPeriodSeconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getMaxRetentionPeriodSeconds()>)   |      |
 | io.prometheus.exemplars.sampleIntervalMilliseconds | [ExemplarsProperties.getSampleIntervalMilliseconds()](</client_java/api/io/prometheus/metrics/config/ExemplarsProperties.html#getSampleIntervalMilliseconds()>) |      |
+<!-- editorconfig-checker-enable --> 
 
 ## Exporter Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                             | Javadoc                                                                                                                                                     | Note |
 | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.includeCreatedTimestamps  | [ExporterProperties.getIncludeCreatedTimestamps()](</client_java/api/io/prometheus/metrics/config/ExporterProperties.html#getIncludeCreatedTimestamps()>)   | (1)  |
 | io.prometheus.exporter.exemplarsOnAllMetricTypes | [ExporterProperties.getExemplarsOnAllMetricTypes()](</client_java/api/io/prometheus/metrics/config/ExporterProperties.html#getExemplarsOnAllMetricTypes()>) | (1)  |
+<!-- editorconfig-checker-enable -->  
 
 (1) Boolean value, `true` or `false`. Default see Javadoc.
 
 ## Exporter Filter Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                                     | Javadoc                                                                                                                                                                   | Note |
 | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.filter.metricNameMustBeEqualTo    | [ExporterFilterProperties.getAllowedMetricNames()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getAllowedMetricNames()>)                 | (1)  |
 | io.prometheus.exporter.filter.metricNameMustNotBeEqualTo | [ExporterFilterProperties.getExcludedMetricNames()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getExcludedMetricNames()>)               | (2)  |
 | io.prometheus.exporter.filter.metricNameMustStartWith    | [ExporterFilterProperties.getAllowedMetricNamePrefixes()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getAllowedMetricNamePrefixes()>)   | (3)  |
 | io.prometheus.exporter.filter.metricNameMustNotStartWith | [ExporterFilterProperties.getExcludedMetricNamePrefixes()](</client_java/api/io/prometheus/metrics/config/ExporterFilterProperties.html#getExcludedMetricNamePrefixes()>) | (4)  |
+<!-- editorconfig-checker-enable --> 
 
 (1) Comma sparated list of allowed metric names. Only these metrics will be exposed.<br/>
 (2) Comma sparated list of excluded metric names. These metrics will not be exposed.<br/>
@@ -113,12 +121,15 @@ This works for all Metrics properties.
 
 ## Exporter HTTPServer Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                   | Javadoc                                                                                                                     | Note |
 | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.httpServer.port | [HTTPServer.Builder.port()](</client_java/api/io/prometheus/metrics/exporter/httpserver/HTTPServer.Builder.html#port(int)>) |      |
+<!-- editorconfig-checker-enable --> 
 
 ## Exporter OpenTelemetry Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                                    | Javadoc                                                                                                                                                                                                       | Note |
 | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.opentelemetry.protocol           | [OpenTelemetryExporter.Builder.protocol()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#protocol(java.lang.String)>)                                     | (1)  |
@@ -131,6 +142,7 @@ This works for all Metrics properties.
 | io.prometheus.exporter.opentelemetry.serviceInstanceId  | [OpenTelemetryExporter.Builder.serviceInstanceId()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#serviceInstanceId(java.lang.String)>)                   |      |
 | io.prometheus.exporter.opentelemetry.serviceVersion     | [OpenTelemetryExporter.Builder.serviceVersion()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#serviceVersion(java.lang.String)>)                         |      |
 | io.prometheus.exporter.opentelemetry.resourceAttributes | [OpenTelemetryExporter.Builder.resourceAttributes()](</client_java/api/io/prometheus/metrics/exporter/opentelemetry/OpenTelemetryExporter.Builder.html#resourceAttribute(java.lang.String,java.lang.String)>) | (3)  |
+<!-- editorconfig-checker-enable --> 
 
 (1) Protocol can be `grpc` or `http/protobuf`.<br>
 (2) Format: `key1=value1,key2=value2`<br>
@@ -143,8 +155,10 @@ See Javadoc for details.
 
 ## Exporter PushGateway Properties
 
+<!-- editorconfig-checker-disable -->
 | Name                                       | Javadoc                                                                                                                                           | Note |
 | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---- |
 | io.prometheus.exporter.pushgateway.address | [PushGateway.Builder.address()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#address(java.lang.String)>) |      |
 | io.prometheus.exporter.pushgateway.scheme  | [PushGateway.Builder.scheme()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#scheme(java.lang.String)>)   |      |
 | io.prometheus.exporter.pushgateway.job     | [PushGateway.Builder.job()](</client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.Builder.html#job(java.lang.String)>)         |      |
+<!-- editorconfig-checker-enable --> 

docs/content/exporters/formats.md

@@ -13,11 +13,15 @@ Moreover, gzip encoding is supported for each of these formats.
 
 ## Scraping with a Prometheus server
 
-The Prometheus server sends an `Accept` header to specify which format is requested. By default, the Prometheus server will scrape OpenMetrics text format with gzip encoding. If the Prometheus server is started with `--enable-feature=native-histograms`, it will scrape Prometheus protobuf format instead.
+The Prometheus server sends an `Accept` header to specify which format is requested. By default, the
+Prometheus server will scrape OpenMetrics text format with gzip encoding. If the Prometheus server
+is started with `--enable-feature=native-histograms`, it will scrape Prometheus protobuf format
+instead.
 
 ## Viewing with a Web Browser
 
-If you view the `/metrics` endpoint with your Web browser you will see Prometheus text format. For quick debugging of the other formats, exporters provide a `debug` URL parameter:
+If you view the `/metrics` endpoint with your Web browser you will see Prometheus text format. For
+quick debugging of the other formats, exporters provide a `debug` URL parameter:
 
 - `/metrics?debug=openmetrics`: View OpenMetrics text format.
 - `/metrics?debug=text`: View Prometheus text format.

docs/content/exporters/pushgateway.md

@@ -115,4 +115,4 @@ The `PushGatewayTestApp` in `integration-tests/it-pushgateway` has a complete ex
 ## Configuration Properties
 
 The [PushGateway](/client_java/api/io/prometheus/metrics/exporter/pushgateway/PushGateway.html) supports a couple of properties that can be configured at runtime.
-See [config](../config/config.md).
+See [config]({{< relref "../config/config.md" >}}).

docs/content/exporters/spring.md

@@ -26,8 +26,7 @@ Spring anyway. Maybe you want full support for all Prometheus metric types,
 or you want to use the new Prometheus native histograms.
 
 The easiest way to use the Prometheus metrics library in Spring is to configure the
-[//]: editorconfig-checker-disable-next-line
-[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
+[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html) <!-- editorconfig-checker-disable-line -->
 to expose metrics.
 
 Dependencies:
@@ -77,8 +76,7 @@ public class DemoApplication {
 ```
 
 The important part are the last three lines: They configure the
-[//]: # editorconfig-checker-disable-next-line
-[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html)
+[PrometheusMetricsServlet](/client_java/api/io/prometheus/metrics/exporter/servlet/jakarta/PrometheusMetricsServlet.html) <!-- editorconfig-checker-disable-line -->
 to expose metrics on `/metrics`:
 
 ```java

docs/content/getting-started/callbacks.md

@@ -3,7 +3,7 @@ title: Callbacks
 weight: 5
 ---
 
-The section on [metric types](../metric-types) showed how to use metrics that actively maintain their state.
+The section on [metric types]({{< relref "metric-types.md" >}}) showed how to use metrics that actively maintain their state.
 
 This section shows how to create callback-based metrics, i.e. metrics that invoke a callback
 at scrape time to get the current values.

docs/content/getting-started/metric-types.md

@@ -117,7 +117,7 @@ most important options:
 See Javadoc
 for [Histogram.Builder](/client_java/api/io/prometheus/metrics/core/metrics/Histogram.Builder.html)
 for a complete list of options. Some options can be configured at runtime,
-see [config](../../config/config).
+see [config]({{< relref "../config/config.md" >}}).
 
 Histograms and summaries are both used for observing distributions. Therefore, the both implement
 the `DistributionDataPoint` interface. Using the `DistributionDataPoint` interface directly gives
@@ -195,7 +195,7 @@ the precise values (error 0.0) with almost no memory overhead.
 Quantile values are calculated based on a 5 minutes moving time window. The default time window can
 be changed with `maxAgeSeconds()` and `numberOfAgeBuckets()`.
 
-Some options can be configured at runtime, see [config](../../config/config).
+Some options can be configured at runtime, see [config]({{< relref "../config/config.md" >}}).
 
 In general you should prefer histograms over summaries. The Prometheus query language has a
 function [histogram_quantile()](https://prometheus.io/docs/prometheus/latest/querying/functions/#histogram_quantile)

docs/content/getting-started/performance.md

@@ -55,7 +55,7 @@ native representation, but not both.
 You can either configure this in code for each histogram by
 calling [classicOnly()](</client_java/api/io/prometheus/metrics/core/metrics/Histogram.Builder.html#classicOnly()>)
 or [nativeOnly()](</client_java/api/io/prometheus/metrics/core/metrics/Histogram.Builder.html#nativeOnly()>),
-or you use the corresponding [config options](../../config/config/).
+or you use the corresponding [config options]({{< relref "../config/config.md" >}}).
 
 One way to do this is with system properties in the command line when you start your application
 

docs/content/getting-started/quickstart.md

@@ -55,7 +55,7 @@ standalone HTTP server.
 {{< hint type=note >}}
 
 If you do not use the protobuf exposition format, you can
-[exclude](../../exporters/formats#exclude-protobuf-exposition-format)
+[exclude]({{< relref "quickstart.md#exclude-protobuf-exposition-format" >}})
 it from the dependencies.
 
 {{< /hint >}}

docs/content/migration/simpleclient.md

@@ -113,7 +113,7 @@ used in Spring, Lombok, and so on. So naming the method `builder()` makes the Pr
 broader Java ecosystem.
 
 If you are using the low level `Collector` API directly, you should have a look at the new callback metric types,
-see [/getting-started/callbacks/](../../getting-started/callbacks/). Chances are good that the new callback metrics have
+see [/getting-started/callbacks/]({{< relref "../getting-started/callbacks.md" >}}). Chances are good that the new callback metrics have
 an easier way to achieve what you need than the old 0.16.0 code.
 
 ## JVM Metrics
@@ -132,7 +132,7 @@ JvmMetrics.builder().register();
 ```
 
 A full list of the available JVM metrics can be found
-on [/instrumentation/jvm](../../instrumentation/jvm/).
+on [/instrumentation/jvm]({{< relref "../instrumentation/jvm.md" >}}).
 
 Most JVM metric names remained the same, except for a few cases where the old 0.16.0 metric names
 were not compliant with the [OpenMetrics](https://openmetrics.io) specification. OpenMetrics