Skip to content

Remove docfx#4036

Merged
carlosalberto merged 4 commits intoopen-telemetry:mainfrom
lmolkova:remove-docfx
May 7, 2024
Merged

Remove docfx#4036
carlosalberto merged 4 commits intoopen-telemetry:mainfrom
lmolkova:remove-docfx

Conversation

@lmolkova
Copy link
Copy Markdown
Member

@lmolkova lmolkova commented May 7, 2024

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 open-telemetry/semantic-conventions#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: open-telemetry/semantic-conventions#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.

@lmolkova lmolkova requested review from a team May 7, 2024 01:28
@carlosalberto
Copy link
Copy Markdown
Contributor

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

@arminru arminru requested a review from reyang May 7, 2024 15:44
@carlosalberto carlosalberto merged commit 2d6456a into open-telemetry:main May 7, 2024
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
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
open-telemetry/semantic-conventions#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:
open-telemetry/semantic-conventions#1008

Closes open-telemetry#4026.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants