Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: checks links in typedoc html #2669

Merged
merged 11 commits into from
Dec 28, 2021

Conversation

legendecas
Copy link
Member

Which problem is this PR solving?

#2657 only checks on markdown files (and doesn't interpret HTML in markdown files). Adopt the tool linkinator that already used in opentelemetry-js-api.

Type of change

  • This change requires a documentation update

Checklist:

  • Followed the style guidelines of this project
  • Documentation has been updated

@legendecas legendecas requested a review from a team December 16, 2021 09:05
@codecov
Copy link

codecov bot commented Dec 16, 2021

Codecov Report

Merging #2669 (fb01d9d) into main (ddede49) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2669   +/-   ##
=======================================
  Coverage   92.53%   92.53%           
=======================================
  Files         144      144           
  Lines        5186     5186           
  Branches     1106     1106           
=======================================
  Hits         4799     4799           
  Misses        387      387           

@@ -174,7 +172,7 @@ For a more detailed breakdown of feature support see the [specification complian
We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and
[good first issue][good-first-issues] to get started with the project. For
instructions to build and make changes to this project, see the
[CONTRIBUTING](CONTRIBUTING.md) guide.
[CONTRIBUTING][CONTRIBUTING] guide.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown link is not accessible in typedoc generated sites.

tsconfig.json Outdated Show resolved Hide resolved
tsconfig.json Outdated Show resolved Hide resolved
@@ -33,8 +33,6 @@
  •  
<a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/development-guide.md">Development Guide</a>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/benchmark/README.md">Benchmarks</a>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Benchmarks have been removed in #2462.

@legendecas legendecas force-pushed the link-checker branch 4 times, most recently from 02557fc to 0a468f3 Compare December 16, 2021 09:41
@legendecas
Copy link
Member Author

No idea why the npm run compile fails for git submodule sync --recursive && git submodule update on GitHub actions. Will continue try to dig into it.

@legendecas legendecas marked this pull request as draft December 16, 2021 09:57
@legendecas legendecas marked this pull request as ready for review December 28, 2021 16:02
@legendecas
Copy link
Member Author

This PR is ready for review. There are chances that typedoc will fail on the CI for OOM, though I didn't constantly reproduce the problem locally. So increasing the memory limit for now.

.github/workflows/lint.yml Show resolved Hide resolved
.github/workflows/lint.yml Show resolved Hide resolved
.github/workflows/lint.yml Show resolved Hide resolved
@dyladan dyladan merged commit 0e9f8af into open-telemetry:main Dec 28, 2021
@legendecas legendecas deleted the link-checker branch December 29, 2021 00:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants