documentation icon indicating copy to clipboard operation
documentation copied to clipboard

[Bug]: Address top 404s (2025-06-05)

Open chalin opened this issue 6 months ago • 5 comments

Top 404s for the past few weeks:

404 path Access count Fix
/docs/2.6/operator/ 147 #933[^1]
/docs/2.6/client-libraries/ 32 #933
/docs/2.6/opentelemetry/ 28 #933
/docs/2.5/client-libraries/ 13
/docs/2.6/cli/ 12 #933
/docs/1.69/opentelemetry/ 9 #933
/docs/1.69/kubernetes/ 5
/docs/1.69/configuration/ 4
/docs/1.69/client-libraries/ 3
/docs/1.8/getting-started/) 3
/img/trace-detail.png 3
/docs/1.27/storage/ 2
/docs/1.27/storage/cassandra/ 2
/docs/1.69/client-libraries 2
/docs/1.69/elasticsearch/ 2
/docs/2.0.6/cli/ 2
/docs/2.0/cli/ 2

[^1]: PR #933 doesn't directly add a rule for the path of this 404, instead it remaps e.g. docs/operator to an appropriate target (/docs/1.69/operator/) -- of which /docs/2.6/operator/ was not.

Steps to reproduce

Data from the GA report on 404s.

Expected behavior

Redirect, when possible.

chalin avatar Jun 05 '25 23:06 chalin

@yurishkuro - would it make sense to redirect /docs/2.*/operator and /docs/operator to /docs/latest/kubernetes?

chalin avatar Jun 05 '25 23:06 chalin

How to you want to handle the client-libraries 404s? Should we:

  1. Redirect to some other target, such as either of: a. https://www.jaegertracing.io/docs/1.63/client-libraries/, the last version for which the page existed -- the page contains a warning at the top that says that Jaeger clients have been deprecated. b. Some other page?
  2. Create a page with a notice about the deprecation, and possibly containing a link to the relevant OTel SDKs on the OTel.io site?
  3. Some other way?

chalin avatar Jun 06 '25 01:06 chalin

Redirect to ... the last version for which the page existed

sounds good, but only from the other 1.x pages. From 2.x it should remain 404 imo (do we actually have links to that from 2.x?)

yurishkuro avatar Jun 06 '25 04:06 yurishkuro

Redirect to ... the last version for which the page existed

sounds good,

Ok, I'll do that.

but only from the other 1.x pages. From 2.x it should remain 404 imo (do we actually have links to that from 2.x?)

No direct links, but this redirect rule (run over "operator") might be causing the issue: https://github.com/jaegertracing/documentation/blob/236bb7eee931039a0f30c6722e8fba293adf772b/themes/jaeger-docs/layouts/partials/redirects.txt#L22

What about for client-libraries?

chalin avatar Jun 06 '25 10:06 chalin

My answer was about client libraries, as well as more generally to keep redirect to the version where it last made sense.

yurishkuro avatar Jun 06 '25 13:06 yurishkuro