[Bug]: Twenty-eight external links yield 404s

[chalin]

What happened?

Working off of #888, external link checking fails with the following 404s:

List of 404s

$ HTMLTEST="~/go/bin/htmltest" make check-links-external 
cp data/refcache.json tmp/.htmltest/refcache.json
~/go/bin/htmltest --conf .htmltest.external.yml
htmltest started at 08:36:44 on public
========================================================================
docs/2.6/configuration/index.html
  Non-OK status: 404 --- docs/2.6/configuration/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.6.0/model/adjuster/clockskew.go
docs/2.6/spm/index.html
  Non-OK status: 404 --- docs/2.6/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.6.0/model/proto/metrics/metricsquery.proto
docs/2.6/cassandra/index.html
  Non-OK status: 404 --- docs/2.6/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.6.0/pkg/cassandra/config/config.go#L21
  Non-OK status: 404 --- docs/2.6/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.6.0/internal/storage/v1/scylladb/README.md
docs/next-release-v2/configuration/index.html
  Non-OK status: 404 --- docs/next-release-v2/configuration/index.html --> https://github.com/jaegertracing/jaeger/blob/main/model/adjuster/clockskew.go
docs/next-release-v2/spm/index.html
  Non-OK status: 404 --- docs/next-release-v2/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/main/model/proto/metrics/metricsquery.proto
docs/next-release-v2/cassandra/index.html
  Non-OK status: 404 --- docs/next-release-v2/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/main/pkg/cassandra/config/config.go#L21
  Non-OK status: 404 --- docs/next-release-v2/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/main/internal/storage/v1/scylladb/README.md
docs/next-release/spm/index.html
  Non-OK status: 404 --- docs/next-release/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/main/model/proto/metrics/metricsquery.proto
docs/next-release/cli/index.html
  Non-OK status: 404 --- docs/next-release/cli/index.html --> https://www.jaegertracing.io/docs/2.6/cli/
docs/next-release/deployment/index.html
  Non-OK status: 404 --- docs/next-release/deployment/index.html --> https://github.com/jaegertracing/jaeger/blob/main/model/adjuster/clockskew.go
docs/next-release/operator/index.html
  Non-OK status: 404 --- docs/next-release/operator/index.html --> https://www.jaegertracing.io/docs/2.6/operator/
  Non-OK status: 404 --- docs/next-release/operator/index.html --> https://spark.apache.org/docs/2.4.4/hardware-provisioning.html#memory
docs/2.4/spm/index.html
  Non-OK status: 404 --- docs/2.4/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.4.0/model/proto/metrics/metricsquery.proto
docs/2.4/cassandra/index.html
  Non-OK status: 404 --- docs/2.4/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.4.0/internal/storage/v1/scylladb/README.md
docs/2.3/spm/index.html
  Non-OK status: 404 --- docs/2.3/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/model/proto/metrics/metricsquery.proto
docs/2.3/apis/index.html
  Non-OK status: 404 --- docs/2.3/apis/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/grpc/proto/storage.proto
docs/2.3/storage/index.html
  Non-OK status: 404 --- docs/2.3/storage/index.html --> https://github.com/jaegertracing/jaeger/tree/v2.3.0/plugin/storage/grpc
docs/2.3/cassandra/index.html
  Non-OK status: 404 --- docs/2.3/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/cassandra/schema/create.sh
  Non-OK status: 404 --- docs/2.3/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/cassandra/schema/README.md
  Non-OK status: 404 --- docs/2.3/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/scylladb/README.md
docs/2.3/badger/index.html
  Non-OK status: 404 --- docs/2.3/badger/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/badger/docs/storage-file-non-root-permission.md
docs/2.5/spm/index.html
  Non-OK status: 404 --- docs/2.5/spm/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.5.0/model/proto/metrics/metricsquery.proto
docs/2.5/cassandra/index.html
  Non-OK status: 404 --- docs/2.5/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.5.0/pkg/cassandra/config/config.go#L21
  Non-OK status: 404 --- docs/2.5/cassandra/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.5.0/internal/storage/v1/scylladb/README.md
docs/2.5/deployment/index.html
  Non-OK status: 404 --- docs/2.5/deployment/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.5.0/model/adjuster/clockskew.go
news/index.html
  Non-OK status: 404 --- news/index.html --> http://jaeger.readthedocs.io/en/latest/getting_started/#all-in-one-docker-image
  Non-OK status: 404 --- news/index.html --> http://jaeger.readthedocs.io/en/latest/getting_started/#sample-application
========================================================================
✘✘✘ failed in 8.659485799s
28 errors in 1474 documents

Steps to reproduce

Run make build check-links-external.

Expected behavior

Link checking should pass.

Tasks - links to fix / resolve

• http://jaeger.readthedocs.io - Replace / resolve any references to jaeger.readthedocs.io, enable full link checking #890
• https://www.jaegertracing.io/docs/2.6/(cli|operator) - Fix page cross-version links, drop canonifyURLs, and more #891
• https://spark.apache.org/docs/2.4.4/hardware-provisioning.html#memory - Fix link into Apache archive #893
• Cleanup:
  • Make full link checking the default, including external links #906
  • Ensure all links have trailing slashes (v1 docs) #907
• https://github.com/jaegertracing/jaeger/(blob|tree)/(v2|main/(internal|model|pkg))

[chalin]

Is https://jaeger.readthedocs.io still supported?

$ curl -sI https://jaeger.readthedocs.io | grep HTTP           
HTTP/2 302 
$ curl -sI https://jaeger.readthedocs.io/en/latest/ | grep HTTP
HTTP/2 404 

[yurishkuro]

Is https://jaeger.readthedocs.io still supported?

it's not

Non-OK status: 404 --- docs/2.3/badger/index.html --> https://github.com/jaegertracing/jaeger/blob/v2.3.0/plugin/storage/badger/docs/storage-file-non-root-permission.md
docs/2.5/spm/index.html

weird. We have a build step that materializes GitHub links like jaeger/blob/main to the version being released. But where the 2.5 showed up here I don't know, perhaps a bug in the script.

[chalin]

How do you propose editing the parts of the docs that refer to jaeger.readthedocs.io? Just remove the prose that refers to it?

That link is also used in many config examples as:

{
  "label": "Docs",
  "url": "http://jaeger.readthedocs.io/en/latest/"
}

What should be used instead?

[yurishkuro]

yes, remove it. It's for very old versions.

For config examples, we can use https://www.jaegertracing.io/docs/latest/