-
Notifications
You must be signed in to change notification settings - Fork 11
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
docs: fix broken links in maintainers.md and hasher's README #153
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #153 +/- ##
=======================================
Coverage 94.66% 94.66%
=======================================
Files 72 72
Lines 3804 3804
=======================================
Hits 3601 3601
Misses 203 203 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
😎
A while back I wrote a tool for detecting this kind of thing: https://github.com/dgoffredo/check-markdown-links. For example, $ cd ~/src/check-markdown-links/check-markdown-links
$ raco pkg install
[...]
$ cd ~/src
$ raco check-markdown-links dd-trace-cpp
The markdown file /home/david/src/dd-trace-cpp/benchmark/README.md references ../example which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/benchmark/google-benchmark/docs/perf_counters.md references ../README.md#custom-counters which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/benchmark/google-benchmark/docs/reducing_variance.md references reducing_variance.md which is problematic because: The file contains a hyperlink to itself.
The markdown file /home/david/src/dd-trace-cpp/benchmark/google-benchmark/docs/reducing_variance.md references user_guide#disabling-cpu-frequency-scaling which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/benchmark/google-benchmark/docs/reducing_variance.md references user_guide#disabling-cpu-frequency-scaling which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/bin/README.md references publish-coverage which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/span.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/dict_writer.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/span_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/trace_segment.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/tracer.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/tracer_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/collector.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/http_client.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/event_scheduler.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/datadog_agent_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/tracer_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/http_client.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/event_scheduler.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/tracer_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/datadog_agent_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/trace_sampler_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/span_sampler_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/rate.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/error.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/expected.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/http_client.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/event_scheduler.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/logger.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/maintainers.md references ../src/datadog/tracer_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/tracer_config.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/trace_segment.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/trace_segment.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/sampling_decision.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/sampling_decision.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/doc/sampling-delegation.md references ../src/datadog/trace_segment.h which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/examples/hasher/README.md references ../bin/hasher-example which is problematic because: The referenced path doesn't exist.
The markdown file /home/david/src/dd-trace-cpp/test/README.md references catch.cpp which is problematic because: The referenced path doesn't exist. |
@dgoffredo Thanks a lot, the missing fixes were done 😄 |
Description
Some links in the documentation where broken:
Changes