Fix malformed links reported by htmltest

Signed-off-by: Yuri Shkuro <[email protected]>
jaegertracing · Nov 24, 2024 · 13d8d0a · 13d8d0a
1 parent bc08f1c
commit 13d8d0a
Show file tree

Hide file tree

Showing 33 changed files with 45 additions and 37 deletions.
diff --git a/.htmltest.old-versions.yml b/.htmltest.old-versions.yml
@@ -0,0 +1,6 @@
+DirectoryPath: public
+IgnoreDirectoryMissingTrailingSlash: true
+CheckExternal: false
+IgnoreAltMissing: true
+IgnoreURLs:
+  - /livereload.js
diff --git a/.htmltest.yml b/.htmltest.yml
@@ -1,6 +1,8 @@
 DirectoryPath: public
-IgnoreDirectoryMissingTrailingSlash: true
 CheckExternal: false
+IgnoreDirectoryMissingTrailingSlash: false
 IgnoreAltMissing: true
 IgnoreURLs:
   - /livereload.js
+IgnoreDirs:
+  - docs/1.*
diff --git a/content/docs/2.0/_index.md b/content/docs/2.0/_index.md
@@ -54,7 +54,7 @@ See [Features](./features/) page for more details.
 
 ## Quick Start
 
-See [Getting Started](./getting-started).
+See [Getting Started](./getting-started/).
 
 ## Screenshots
 

diff --git a/content/docs/2.0/apis.md b/content/docs/2.0/apis.md
@@ -109,7 +109,7 @@ For programmatic access to the service graph, the recommended API is gRPC/Protob
 
 ## Service Performance Monitoring (internal)
 
-Please refer to the [SPM Documentation](../spm#api)
+Please refer to the [SPM Documentation](../spm/#api)
 
 ## gRPC Server Introspection
 

diff --git a/content/docs/2.0/features.md b/content/docs/2.0/features.md
@@ -65,7 +65,7 @@ At this time the transitive graph can only be constructed from traces in the sea
 
 SPM allows monitoring and investigating trends in the performance of the services by computing aggregate metrics from traces and visualizing them as time series charts. It is a powerful tool to identify and investigate performance issues,
 
-See [Service Performance Monitoring (SPM)](../spm) for more details.
+See [Service Performance Monitoring (SPM)](../spm/) for more details.
 
 ## Zipkin Compatibility
 

diff --git a/content/docs/2.0/frontend-ui.md b/content/docs/2.0/frontend-ui.md
@@ -10,7 +10,7 @@ weight: 7
 Several aspects of the UI can be configured:
 
   * The Dependencies section can be enabled / configured
-  * The [Monitor tab (aka: Service Performance Monitoring)](../spm) can be enabled / configured
+  * The [Monitor tab (aka: Service Performance Monitoring)](../spm/) can be enabled / configured
   * App analytics tracking can be enabled / configured (via Google Analytics or custom plugin)
   * Additional menu options can be added to the global nav
   * Search input limits can be configured

diff --git a/content/docs/2.0/getting-started.md b/content/docs/2.0/getting-started.md
@@ -59,7 +59,7 @@ Then navigate to `http://localhost:8080`. See the [README](https://github.com/ja
 
 ## SPM
 
-The Service Performance Monitoring (SPM) page has its own [Quick Start](../spm#getting-started) that shows how to explore that aspect of Jaeger.
+The Service Performance Monitoring (SPM) page has its own [Quick Start](../spm/#getting-started) that shows how to explore that aspect of Jaeger.
 
 [hotrod-tutorial]: https://medium.com/jaegertracing/take-jaeger-for-a-hotrod-ride-233cf43e46c2
 [otel]: https://opentelemetry.io
diff --git a/content/docs/2.0/monitoring.md b/content/docs/2.0/monitoring.md
@@ -41,7 +41,7 @@ The log level can be adjusted via `--log-level` command line switch; default lev
 
 ## Traces
 
-Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
+Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started/), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
 
 ```
 docker run -e OTEL_TRACES_SAMPLER=always_off -p 16686:16686 jaegertracing/all-in-one:{{< currentVersion >}}

diff --git a/content/docs/2.0/operations.md b/content/docs/2.0/operations.md
@@ -12,4 +12,4 @@ children:
   url: tools
 ---
 
-Jaeger provides the foundational components to operate your installation. Please note that backups and lifecycle of the datastores must be handled outside of Jaeger. We provide pointers to components within the [storage backends](../architecture) guides. 
+Jaeger provides the foundational components to operate your installation. Please note that backups and lifecycle of the datastores must be handled outside of Jaeger. We provide pointers to components within the [storage backends](../architecture/) guides. 
diff --git a/content/docs/2.0/sampling.md b/content/docs/2.0/sampling.md
@@ -31,7 +31,7 @@ These are two basic types of head samplers that are used by the remote sampling:
 * **Probabilistic** sampler makes a random sampling decision with a pre-configured probability. For example, with `probability=0.1` approximately 1 in 10 traces will be sampled.
 * **Rate Limiting** sampler uses a leaky bucket rate limiter to ensure that traces are sampled with a certain constant rate. For example, when `rate=2.0` it will sample requests with the rate of 2 traces per second.
 
-[remote-sampling-api]: ../apis#remote-sampling-configuration-stable
+[remote-sampling-api]: ../apis/#remote-sampling-configuration-stable
 
 ### File-based Sampling Configuration
 

diff --git a/content/docs/2.0/spm.md b/content/docs/2.0/spm.md
@@ -166,7 +166,7 @@ Note:
 
 The following configuration is required to enable the SPM feature:
 
-- [Jaeger UI](../frontend-ui#monitor)
+- [Jaeger UI](../frontend-ui/#monitor)
 - Jaeger Query (TODO: these instructions need to be updated for config file)
   - Set the `METRICS_STORAGE_TYPE` environment variable to `prometheus`.
   - Optional: Set `--prometheus.server-url` (or `PROMETHEUS_SERVER_URL` environment variable)

diff --git a/content/docs/next-release-v2/_index.md b/content/docs/next-release-v2/_index.md
@@ -54,7 +54,7 @@ See [Features](./features/) page for more details.
 
 ## Quick Start
 
-See [Getting Started](./getting-started).
+See [Getting Started](./getting-started/).
 
 ## Screenshots
 

diff --git a/content/docs/next-release-v2/apis.md b/content/docs/next-release-v2/apis.md
@@ -109,7 +109,7 @@ For programmatic access to the service graph, the recommended API is gRPC/Protob
 
 ## Service Performance Monitoring (internal)
 
-Please refer to the [SPM Documentation](../spm#api)
+Please refer to the [SPM Documentation](../spm/#api)
 
 ## gRPC Server Introspection
 

diff --git a/content/docs/next-release-v2/features.md b/content/docs/next-release-v2/features.md
@@ -65,7 +65,7 @@ At this time the transitive graph can only be constructed from traces in the sea
 
 SPM allows monitoring and investigating trends in the performance of the services by computing aggregate metrics from traces and visualizing them as time series charts. It is a powerful tool to identify and investigate performance issues,
 
-See [Service Performance Monitoring (SPM)](../spm) for more details.
+See [Service Performance Monitoring (SPM)](../spm/) for more details.
 
 ## Zipkin Compatibility
 

diff --git a/content/docs/next-release-v2/frontend-ui.md b/content/docs/next-release-v2/frontend-ui.md
@@ -10,7 +10,7 @@ weight: 7
 Several aspects of the UI can be configured:
 
   * The Dependencies section can be enabled / configured
-  * The [Monitor tab (aka: Service Performance Monitoring)](../spm) can be enabled / configured
+  * The [Monitor tab (aka: Service Performance Monitoring)](../spm/) can be enabled / configured
   * App analytics tracking can be enabled / configured (via Google Analytics or custom plugin)
   * Additional menu options can be added to the global nav
   * Search input limits can be configured

diff --git a/content/docs/next-release-v2/getting-started.md b/content/docs/next-release-v2/getting-started.md
@@ -55,7 +55,7 @@ Then navigate to `http://localhost:8080`. See the [README](https://github.com/ja
 
 ## SPM
 
-The Service Performance Monitoring (SPM) page has its own [Quick Start](../spm#getting-started) that shows how to explore that aspect of Jaeger.
+The Service Performance Monitoring (SPM) page has its own [Quick Start](../spm/#getting-started) that shows how to explore that aspect of Jaeger.
 
 [hotrod-tutorial]: https://medium.com/jaegertracing/take-jaeger-for-a-hotrod-ride-233cf43e46c2
 [otel]: https://opentelemetry.io
diff --git a/content/docs/next-release-v2/monitoring.md b/content/docs/next-release-v2/monitoring.md
@@ -41,7 +41,7 @@ The log level can be adjusted via `--log-level` command line switch; default lev
 
 ## Traces
 
-Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
+Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started/), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
 
 ```
 docker run -e OTEL_TRACES_SAMPLER=always_off -p 16686:16686 jaegertracing/all-in-one:{{< currentVersion >}}

diff --git a/content/docs/next-release-v2/operations.md b/content/docs/next-release-v2/operations.md
@@ -12,4 +12,4 @@ children:
   url: tools
 ---
 
-Jaeger provides the foundational components to operate your installation. Please note that backups and lifecycle of the datastores must be handled outside of Jaeger. We provide pointers to components within the [storage backends](../architecture) guides. 
+Jaeger provides the foundational components to operate your installation. Please note that backups and lifecycle of the datastores must be handled outside of Jaeger. We provide pointers to components within the [storage backends](../architecture/) guides.
diff --git a/content/docs/next-release-v2/sampling.md b/content/docs/next-release-v2/sampling.md
@@ -31,7 +31,7 @@ These are two basic types of head samplers that are used by the remote sampling:
 * **Probabilistic** sampler makes a random sampling decision with a pre-configured probability. For example, with `probability=0.1` approximately 1 in 10 traces will be sampled.
 * **Rate Limiting** sampler uses a leaky bucket rate limiter to ensure that traces are sampled with a certain constant rate. For example, when `rate=2.0` it will sample requests with the rate of 2 traces per second.
 
-[remote-sampling-api]: ../apis#remote-sampling-configuration-stable
+[remote-sampling-api]: ../apis/#remote-sampling-configuration-stable
 
 ### File-based Sampling Configuration
 

diff --git a/content/docs/next-release-v2/spm.md b/content/docs/next-release-v2/spm.md
@@ -166,7 +166,7 @@ Note:
 
 The following configuration is required to enable the SPM feature:
 
-- [Jaeger UI](../frontend-ui#monitor)
+- [Jaeger UI](../frontend-ui/#monitor)
 - Jaeger Query (TODO: these instructions need to be updated for config file)
   - Set the `METRICS_STORAGE_TYPE` environment variable to `prometheus`.
   - Optional: Set `--prometheus.server-url` (or `PROMETHEUS_SERVER_URL` environment variable)

diff --git a/content/docs/next-release/_index.md b/content/docs/next-release/_index.md
@@ -8,7 +8,7 @@ children:
 
 Welcome to Jaeger's documentation portal! Below, you'll find information for beginners and experienced Jaeger users.
 
-If you cannot find what you are looking for, or have an issue not covered here, we'd love to [hear from you](/get-in-touch).
+If you cannot find what you are looking for, or have an issue not covered here, we'd love to [hear from you](/get-in-touch/).
 
 If you are new to distributed tracing, please take a look at the [Related Links](#related-links) section below.
 
@@ -51,7 +51,7 @@ See [Features](./features/) page for more details.
 
 ## Quick Start
 
-See [Getting Started](./getting-started).
+See [Getting Started](./getting-started/).
 
 ## Screenshots
 

diff --git a/content/docs/next-release/apis.md b/content/docs/next-release/apis.md
@@ -115,7 +115,7 @@ For programmatic access to the service graph, the recommended API is gRPC/Protob
 
 ## Service Performance Monitoring (internal)
 
-Please refer to the [SPM Documentation](../spm#api)
+Please refer to the [SPM Documentation](../spm/#api)
 
 [jaeger-idl]: https://github.com/jaegertracing/jaeger-idl/
 [jaeger.thrift]: https://github.com/jaegertracing/jaeger-idl/blob/main/thrift/jaeger.thrift

diff --git a/content/docs/next-release/architecture.md b/content/docs/next-release/architecture.md
@@ -102,11 +102,11 @@ The instrumentation is designed to be always on in production. To minimize  over
 
 ### Collector
 
-**jaeger-collector** receives traces, runs them through a processing pipeline for validation and clean-up/enrichment, and stores them in a storage backend. Jaeger comes with built-in support for several storage backends (see [Deployment](../deployment)), as well as extensible plugin framework for implementing custom storage plugins.
+**jaeger-collector** receives traces, runs them through a processing pipeline for validation and clean-up/enrichment, and stores them in a storage backend. Jaeger comes with built-in support for several storage backends (see [Deployment](../deployment/)), as well as extensible plugin framework for implementing custom storage plugins.
 
 ### Query
 
-**jaeger-query** is a service that exposes the [APIs](../apis) for retrieving traces from storage and hosts a Web UI for searching and analyzing traces.
+**jaeger-query** is a service that exposes the [APIs](../apis/) for retrieving traces from storage and hosts a Web UI for searching and analyzing traces.
 
 ### Ingester
 

diff --git a/content/docs/next-release/deployment.md b/content/docs/next-release/deployment.md
@@ -601,7 +601,7 @@ Known remote storage backends:
 ## Metrics Storage Backends
 
 Jaeger Query is capable of querying aggregated R.E.D metrics from a storage backend,
-visualizing them on the [Monitor tab](../spm). It should be emphasized that the
+visualizing them on the [Monitor tab](../spm/). It should be emphasized that the
 configured metrics storage type is for reading _only_ and therefore, only applies
 to the Jaeger Query component (and All In One, which contains Jaeger Query).
 

diff --git a/content/docs/next-release/faq.md b/content/docs/next-release/faq.md
@@ -18,7 +18,7 @@ Please refer to the [Troubleshooting](../troubleshooting/) guide.
 
 ## What happened to jaeger-agent?
 
-Since the Jaeger client libraries [are deprecated](../../../sdk-migration) and the OpenTelemetry SDKs phased out support for Jaeger Thrift format, the **jaeger-agent** is no longer required and no longer supported. See the [Architecture](../architecture) page for alternative deployment options.
+Since the Jaeger client libraries [are deprecated](../../../sdk-migration/) and the OpenTelemetry SDKs phased out support for Jaeger Thrift format, the **jaeger-agent** is no longer required and no longer supported. See the [Architecture](../architecture/) page for alternative deployment options.
 
 Sometimes it is still desirable to run a **host agent**:
 

diff --git a/content/docs/next-release/features.md b/content/docs/next-release/features.md
@@ -72,6 +72,6 @@ to highlight services and/or operations with statistically significant request/e
 latencies, then leveraging Jaeger's Trace Search capabilities to pinpoint specific
 traces belonging to these services/operations.
 
-See [Service Performance Monitoring (SPM)](../spm) for more details.
+See [Service Performance Monitoring (SPM)](../spm/) for more details.
 
 [otlp]: https://opentelemetry.io/docs/reference/specification/protocol/
diff --git a/content/docs/next-release/frontend-ui.md b/content/docs/next-release/frontend-ui.md
@@ -10,7 +10,7 @@ weight: 7
 Several aspects of the UI can be configured:
 
   * The Dependencies section can be enabled / configured
-  * The [Monitor tab (aka: Service Performance Monitoring)](../spm) can be enabled / configured
+  * The [Monitor tab (aka: Service Performance Monitoring)](../spm/) can be enabled / configured
   * App analytics tracking can be enabled / configured (via Google Analytics or custom plugin)
   * Additional menu options can be added to the global nav
   * Search input limits can be configured

diff --git a/content/docs/next-release/getting-started.md b/content/docs/next-release/getting-started.md
@@ -54,7 +54,7 @@ Port  | Protocol | Component | Function
 
 ### With Service Performance Monitoring (SPM)
 
-Please refer to [Service Performance Monitoring (SPM)](../spm#getting-started).
+Please refer to [Service Performance Monitoring (SPM)](../spm/#getting-started).
 
 ## On Kubernetes
 

diff --git a/content/docs/next-release/monitoring.md b/content/docs/next-release/monitoring.md
@@ -40,7 +40,7 @@ The log level can be adjusted via `--log-level` command line switch; default lev
 
 ## Traces
 
-Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
+Jaeger has the ability to trace some of its own components, namely the requests to the Query service. For example, if you start `all-in-one` as described in [Getting Started](../getting-started/), and refresh the UI screen a few times, you will see `jaeger-all-in-one` populated in the Services dropdown. If you prefer not to see these traces in the Jaeger UI, you can disable them by running Jaeger backend components with `OTEL_TRACES_SAMPLER=always_off` environment variable, for example:
 
 ```
 docker run -e OTEL_TRACES_SAMPLER=always_off -p 16686:16686 jaegertracing/all-in-one:{{< currentVersion >}}

diff --git a/content/docs/next-release/operator.md b/content/docs/next-release/operator.md
@@ -675,7 +675,7 @@ Sidecar plugins will not be supported from v1.58. Custom storage backends should
 
 Setting `spec.metricsStorage.type` to `prometheus` enables using Jaeger with
 PromQL-compatible storage implementations to **jaeger-query** R.E.D metrics for the
-[Service Performance Monitoring](../spm) feature.
+[Service Performance Monitoring](../spm/) feature.
 
 The following is an example of a Jaeger CR using the `allInOne` deployment strategy,
 an in-memory span storage and prometheus metrics storage.
@@ -705,7 +705,7 @@ spec:
 
 <1> Beginning of `prometheus`-namespaced configuration, defined as a simple `key: value` map.
     All available options are documented in the
-    [Jaeger All-In-One with Prometheus CLI section](../cli#jaeger-all-in-one-prometheus)
+    [Jaeger All-In-One with Prometheus CLI section](../cli/#jaeger-all-in-one-prometheus)
 
 <2> Overrides the default `http://localhost:9090` prometheus server URL with `http://prometheus:9090`.
 

diff --git a/content/docs/next-release/sampling.md b/content/docs/next-release/sampling.md
@@ -23,7 +23,7 @@ When using configuration object to instantiate the tracer, the type of sampling
 
 If your client SDKs are configured to use remote sampling configuration (see [Remote Sampling API][remote-sampling-api]) then sampling rates can be centrally controlled via **jaeger-collector**s. In this setup a sampling strategy configuration is served to the client SDK that describes endpoints and their sampling probabilities. This configuration can be generated by **jaeger-collector** in two different ways: [periodically loaded from a file](#file-based-sampling-configuration) or [dynamically calculated based on traffic](#adaptive-sampling). The method of generation is controlled by the environment variable `SAMPLING_CONFIG_TYPE` which can be set to either `file` (default) or `adaptive`.
 
-[remote-sampling-api]: ../apis#remote-sampling-configuration-stable
+[remote-sampling-api]: ../apis/#remote-sampling-configuration-stable
 
 ### File-based Sampling Configuration
 

diff --git a/content/docs/next-release/spm.md b/content/docs/next-release/spm.md
@@ -166,8 +166,8 @@ Note:
 
 The following configuration is required to enable the SPM feature:
 
-- [Jaeger UI](../frontend-ui#monitor)
-- [Jaeger Query](../cli#jaeger-query-prometheus)
+- [Jaeger UI](../frontend-ui/#monitor)
+- [Jaeger Query](../cli/#jaeger-query-prometheus)
   - Set the `METRICS_STORAGE_TYPE` environment variable to `prometheus`.
   - Optional: Set `--prometheus.server-url` (or `PROMETHEUS_SERVER_URL` environment variable)
     to the URL of the prometheus server. Default: http://localhost:9090.

diff --git a/content/get-involved.md b/content/get-involved.md
@@ -7,8 +7,8 @@ CNCF guide on [how to start contributing to open source and figure out where to
 
 ## No-coding involvement
 
-* Join the [online chat room](../get-in-touch) and help answering questions from the rest of the community.
-* Join our [bi-weekly video calls](../get-in-touch) to discuss issues, large initiatives, or present case studies.
+* Join the [online chat room](../get-in-touch/) and help answering questions from the rest of the community.
+* Join our [bi-weekly video calls](../get-in-touch/) to discuss issues, large initiatives, or present case studies.
 * Help documenting answers to common questions, either in [Jaeger documentation](https://github.com/jaegertracing/documentation) or [Stackoverflow](https://stackoverflow.com/questions/tagged/jaeger).
 * Help improving [Jaeger documentation](https://github.com/jaegertracing/documentation), especially if you yourself run into issues where something is not clear or not working.
 * Publish blog posts or tutorials about Jaeger, for example: