From f989ad7939b1b0cc403abc10738070a7761e1394 Mon Sep 17 00:00:00 2001 From: Paul Abel Date: Wed, 2 Jul 2025 13:48:14 +0100 Subject: [PATCH 1/3] Update links to address markdown lint issues --- CONTRIBUTING.md | 2 +- README.md | 6 +++--- examples/basic_auth/README.md | 3 +-- examples/tls/README.md | 3 +-- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0116bc5a4..b5112db5b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,7 +69,7 @@ issue template. ### F5 Contributor License Agreement (CLA) -F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) +F5 requires all external contributors to agree to the terms of the [F5 CLA](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md) before any of their changes can be incorporated into an F5 Open Source repository. If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and diff --git a/README.md b/README.md index 947a336fa..2d868186f 100644 --- a/README.md +++ b/README.md @@ -254,7 +254,7 @@ Flags: | `nginxplus_server_zone_processing` | Gauge | Client requests that are currently being processed | `server_zone` | | `nginxplus_server_zone_requests` | Counter | Total client requests | `server_zone` | | `nginxplus_server_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server_zone` | -| `nginxplus_server_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server_zone` | +| `nginxplus_server_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `server_zone` | | `nginxplus_server_zone_discarded` | Counter | Requests completed without sending a response | `server_zone` | | `nginxplus_server_zone_received` | Counter | Bytes received from clients | `server_zone` | | `nginxplus_server_zone_sent` | Counter | Bytes sent to clients | `server_zone` | @@ -288,7 +288,7 @@ Flags: | `nginxplus_upstream_server_limit` | Gauge | Limit for connections which corresponds to the max_conns parameter of the upstream server. Zero value means there is no limit | `server`, `upstream` | | `nginxplus_upstream_server_requests` | Counter | Total client requests | `server`, `upstream` | | `nginxplus_upstream_server_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `server`, `upstream` | -| `nginxplus_upstream_server_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `server`, `upstream` | +| `nginxplus_upstream_server_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `server`, `upstream` | | `nginxplus_upstream_server_sent` | Counter | Bytes sent to this server | `server`, `upstream` | | `nginxplus_upstream_server_received` | Counter | Bytes received to this server | `server`, `upstream` | | `nginxplus_upstream_server_fails` | Counter | Number of unsuccessful attempts to communicate with the server | `server`, `upstream` | @@ -348,7 +348,7 @@ Flags: | ----------------------------------------- | ------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | | `nginxplus_location_zone_requests` | Counter | Total client requests | `location_zone` | | `nginxplus_location_zone_responses` | Counter | Total responses sent to clients | `code` (the response status code. The values are: `1xx`, `2xx`, `3xx`, `4xx` and `5xx`), `location_zone` | -| `nginxplus_location_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The possible values are [here](https://www.nginx.com/resources/wiki/extending/api/http/)), `location_zone` | +| `nginxplus_location_zone_responses_codes` | Counter | Total responses sent to clients by code | `code` (the response status code. The [possible values](https://www.nginx.com/resources/wiki/extending/api/http/) are available on the NGINX Wiki), `location_zone` | | `nginxplus_location_zone_discarded` | Counter | Requests completed without sending a response | `location_zone` | | `nginxplus_location_zone_received` | Counter | Bytes received from clients | `location_zone` | | `nginxplus_location_zone_sent` | Counter | Bytes sent to clients | `location_zone` | diff --git a/examples/basic_auth/README.md b/examples/basic_auth/README.md index 31d5dce52..eaf2a8125 100644 --- a/examples/basic_auth/README.md +++ b/examples/basic_auth/README.md @@ -4,8 +4,7 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables basic authentication. It is configured to have a single user `alice` with password `password`. -The full documentation for the web configuration can be found -[here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). +See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. diff --git a/examples/tls/README.md b/examples/tls/README.md index 70d885e52..d83b80247 100644 --- a/examples/tls/README.md +++ b/examples/tls/README.md @@ -4,8 +4,7 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables TLS and specifies the path to the TLS certificate and key files. Additionally, there are two example TLS files `server.crt` and `server.key` that are used in the configuration. -The full documentation for the web configuration can be found -[here](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md). +See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. From 3bdde04285feb25f4e42ee42efc474cd6c4a0eee Mon Sep 17 00:00:00 2001 From: Paul Abel Date: Wed, 2 Jul 2025 14:25:04 +0100 Subject: [PATCH 2/3] reduce line length --- examples/basic_auth/README.md | 3 ++- examples/tls/README.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/examples/basic_auth/README.md b/examples/basic_auth/README.md index eaf2a8125..8ab0f0243 100644 --- a/examples/basic_auth/README.md +++ b/examples/basic_auth/README.md @@ -4,7 +4,8 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables basic authentication. It is configured to have a single user `alice` with password `password`. -See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. +See the full documentation of the +[web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. diff --git a/examples/tls/README.md b/examples/tls/README.md index d83b80247..a3026cf66 100644 --- a/examples/tls/README.md +++ b/examples/tls/README.md @@ -4,7 +4,8 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables TLS and specifies the path to the TLS certificate and key files. Additionally, there are two example TLS files `server.crt` and `server.key` that are used in the configuration. -See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. +See the full documentation of the +[web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. From e66fb8dfb03a3f6d8caa996ed94d7882e7ba26f2 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 2 Jul 2025 13:25:26 +0000 Subject: [PATCH 3/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- examples/basic_auth/README.md | 2 +- examples/tls/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/basic_auth/README.md b/examples/basic_auth/README.md index 8ab0f0243..d43215f0b 100644 --- a/examples/basic_auth/README.md +++ b/examples/basic_auth/README.md @@ -4,7 +4,7 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables basic authentication. It is configured to have a single user `alice` with password `password`. -See the full documentation of the +See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details. diff --git a/examples/tls/README.md b/examples/tls/README.md index a3026cf66..22b0365a4 100644 --- a/examples/tls/README.md +++ b/examples/tls/README.md @@ -4,7 +4,7 @@ This example shows how to run NGINX Prometheus Exporter with web configuration. configuration `web-config.yml` that enables TLS and specifies the path to the TLS certificate and key files. Additionally, there are two example TLS files `server.crt` and `server.key` that are used in the configuration. -See the full documentation of the +See the full documentation of the [web configuration](https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md) for more details.