semantic-conventions icon indicating copy to clipboard operation
semantic-conventions copied to clipboard

[editorial] Anchor IDs do not exist in v1.27 of docs

Open chalin opened this issue 1 year ago • 3 comments

  • [x] Context: #1072 There are two occurrences of links with the following URL: /docs/database/database-spans.md#batch-operations, but that anchor ID doesn't exist. What did you have in mind as a target @trask?
  • [x] Context: #1006 There are two occurrences of links with the following URL: /docs/messaging/messaging-spans.md#common-messaging-operations, but that anchor ID doesn't exist. What did you have in mind as a target @lmolkova?

These issues were reported by the link checker via the GitHub action checks of:

  • https://github.com/open-telemetry/opentelemetry.io/pull/4938

In particular, see the "hash does not exist" errors reported in: https://github.com/open-telemetry/opentelemetry.io/actions/runs/10218743437/job/28275657390?pr=4938

chalin avatar Aug 02 '24 17:08 chalin

Thanks @chalin !

Is there a way we can easily test it before releasing? I.e. can we somehow trigger docs pipeline for a specific commit in the semconv repo?

We used to have cross-file link checker, but it's gone and we have no replacement for it across all repos - https://github.com/open-telemetry/semantic-conventions/issues/1009.

lmolkova avatar Aug 02 '24 18:08 lmolkova

The easiest way that I can think of, would be to build the OTel website using the pre-release commit of this repo. We could define a manually triggered workflow that could build the OTel website using main@HEAD, which could be run just before putting out the release. /cc @open-telemetry/docs-maintainers

I suppose that the same workflow could be run via a cron job over main@HEAD, but that might report more errors than it's worth? Maybe not.

chalin avatar Aug 02 '24 23:08 chalin

Related:

  • #1316

chalin avatar Aug 02 '24 23:08 chalin