search

open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
272 stars 174 forks source link

[editorial] Broken links due to misnamed anchor ID etc #1564

Open chalin opened 3 days ago

chalin commented 3 days ago

Area(s)

area:docs

What happened?

As can be see from this build log, https://github.com/open-telemetry/opentelemetry.io/actions/runs/11751326636/job/32741156852#step:7:282, there broken links due to invalid hashes:

htmltest started at 12:05:29 on public
========================================================================
running in concurrent mode, this is experimental
docs/specs/semconv/database/mssql/index.html
  hash does not exist --- docs/specs/semconv/database/mssql/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/mariadb/index.html
  hash does not exist --- docs/specs/semconv/database/mariadb/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/cassandra/index.html
  hash does not exist --- docs/specs/semconv/database/cassandra/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/sql/index.html
  hash does not exist --- docs/specs/semconv/database/sql/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/database-metrics/index.html
  hash does not exist --- docs/specs/semconv/database/database-metrics/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
  hash does not exist --- docs/specs/semconv/database/database-metrics/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/database-spans/index.html
  hash does not exist --- docs/specs/semconv/database/database-spans/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/mysql/index.html
  hash does not exist --- docs/specs/semconv/database/mysql/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
docs/specs/semconv/database/postgresql/index.html
  hash does not exist --- docs/specs/semconv/database/postgresql/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
...
docs/specs/semconv/attributes-registry/db/index.html
  hash does not exist --- docs/specs/semconv/attributes-registry/db/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
...
docs/specs/semconv/database/cosmosdb/index.html
  hash does not exist --- docs/specs/semconv/database/cosmosdb/index.html --> /docs/specs/semconv/database/database-spans/#generating-a-summary-of-the-quey-text
  hash does not exist --- docs/specs/semconv/database/cosmosdb/index.html --> /docs/specs/semconv/database/database-metrics/##metric-dbclientresponsereturned_rows
...
========================================================================
✘✘✘ failed in 2m29.953674131s
12 errors in 1992 documents

In particular, note:

After you fix the links, you can test them again by running:

Related:

/cc @lmolkova

Semantic convention version

main@HEAD

chalin commented 3 days ago

/cc @open-telemetry/docs-maintainers

lmolkova commented 3 days ago

thank you! Let's see how we can leverage it in the release process with other @open-telemetry/specs-semconv-maintainers