Add cross-file anchor link check (use lychee for markdown link checking) and fix broken links

[trask]

@chalin @lmolkova do we still need this release step after this?

Run opentelemetry.io workflow against opentelemetry-specification submodule as a smoke-test for docs. Fix broken links, if any.

[chalin]

Great! LGTM

I'd keep the release step since it can catch anchor hashes to level-one headings, which correspond to titles in the published website, and hence don't exist in the rendered OTel.io site pages. It might also be able to catch inter-spec link issues.

[lmolkova]

YAY!!!!

[lmolkova]

@chalin @lmolkova do we still need this release step after this?

I'd keep the release step since it can catch anchor hashes to level-one headings, which correspond to titles in the published website, and hence don't exist in the rendered OTel.io site pages. It might also be able to catch inter-spec link issues.

I believe lychee should cover inter-spec links and anchors. I'd prefer not to have manual step if we can avoid it.

[chalin]

Right, but lychee can't call out intra-spec links to page titles, which will fail during the website build.

[trask]

intra-spec links to page titles

can you give an example, I don't know what this means, thanks

[carlosalberto]

Thanks so much for this!

[github-actions]

This PR was marked stale due to lack of activity. It will be closed in 7 days.

[carlosalberto]

Ping @chalin ;)

[chalin]

intra-spec links to page titles

can you give an example, I don't know what this means, thanks

Thanks for the ping @carlosalberto. Sorry for the delay in responding @trask, I didn't notice your question until now. Here is an example of a link fix necessary for the website, but that would pass link checking here (unless lychee can report a warning when there are links to level 1 headings):

• [editorial] Fix link: drop anchor ID to page title #4080

[trask]

Here is an example of a link fix necessary for the website

thanks