open-telemetry / opentelemetry-specification

Specifications for OpenTelemetry
https://opentelemetry.io
Apache License 2.0
3.64k stars 870 forks source link

Remove docfx #4036

Closed lmolkova closed 1 month ago

lmolkova commented 1 month ago

DocFx v3 is no longer available and not intended to be used externally.

The feature it provided that we don't have from other tooling is cross-file anchor reference check, see https://github.com/open-telemetry/semantic-conventions/issues/1009 for the details. It seems there is no popular (or even not popular) replacement for it.

DocFx v2 only check anchors within the same file which markdownlint does as well.

Related: https://github.com/open-telemetry/semantic-conventions/pull/1008

Closes #4026.

Changes

This PR removes docfx since v2 does not provide additional value. We'll need to find a different solution for relative anchor checks.

carlosalberto commented 1 month ago

Let's give a heads up to people on today's Spec call, and otherwise let's merge this fast.