docs: fix broken links in maintainers.md and hasher's README by dubloom · Pull Request #153

docs: fix broken links in maintainers.md and hasher's README by dubloom · Pull Request #153 · DataDog/dd-trace-cpp

Description

Some links in the documentation where broken:

In maintainers.md a lot of links were pointing to /src instead of /include
In the README.md of the hasher example, the path to the script to execute the example was wrong.

Changes

Fix the links

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.66%. Comparing base (16cf1eb) to head (544091c).

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.
📢 Have feedback on the report? Share it here.

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 😄

Benchmarks

Benchmark execution time: 2024-09-13 15:05:30

Comparing candidate commit 544091c in PR branch dubloom/fix-broken-links with baseline commit 16cf1eb in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 1 metrics, 0 unstable metrics.

dmehala deleted the dubloom/fix-broken-links branch

September 15, 2024 12:36