Skip to content

Automate Dead Link Detection in Docs#3397

Closed
fjlanasa wants to merge 3 commits intomainfrom
fl/OSSEVALML-289
Closed

Automate Dead Link Detection in Docs#3397
fjlanasa wants to merge 3 commits intomainfrom
fl/OSSEVALML-289

Conversation

@fjlanasa
Copy link
Copy Markdown
Contributor

@fjlanasa fjlanasa commented Mar 22, 2022

Pull Request Description

Closes #3364


After creating the pull request: in order to pass the release_notes_updated check you will need to update the "Future Release" section of docs/source/release_notes.rst to include this pull request by adding :pr:123.

@fjlanasa fjlanasa changed the title OSSEVALML-289 automate dead link detection automate dead link detection Mar 22, 2022
@fjlanasa fjlanasa changed the title automate dead link detection Automate Dead Link Detection in Docs Mar 22, 2022
@fjlanasa fjlanasa requested a review from freddyaboulton March 22, 2022 18:00
runs-on: ubuntu-latest
strategy:
matrix:
page:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is there a way we can point it to index and have it check all pages? Worried we'll forget to update this if new pages are added.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i am not sure if there is a good way to do that without also recursively crawling all links within each page.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Does that lead to many false positives?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I can give it a shot. The main issue is that it takes a very long time, but I initially ruled it out when I thought we would run this check for each PR, so I guess it's not as big of an issue if it still works.

Comment thread .github/workflows/broken_link_checker.yml Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 22, 2022

Codecov Report

Merging #3397 (91ba2e0) into main (a604c88) will decrease coverage by 3.5%.
The diff coverage is n/a.

❗ Current head 91ba2e0 differs from pull request most recent head 58330e8. Consider uploading reports for the commit 58330e8 to get more accurate results

@@           Coverage Diff           @@
##            main   #3397     +/-   ##
=======================================
- Coverage   99.7%   96.2%   -3.4%     
=======================================
  Files        329     329             
  Lines      32394   32394             
=======================================
- Hits       32265   31160   -1105     
- Misses       129    1234   +1105     
Impacted Files Coverage Δ
evalml/tests/component_tests/test_oversampler.py 16.6% <0.0%> (-83.4%) ⬇️
...alml/tests/component_tests/test_lgbm_classifier.py 18.0% <0.0%> (-82.0%) ⬇️
...valml/tests/component_tests/test_target_encoder.py 18.0% <0.0%> (-82.0%) ⬇️
...valml/tests/component_tests/test_lgbm_regressor.py 18.9% <0.0%> (-81.1%) ⬇️
...alml/tests/component_tests/test_arima_regressor.py 23.2% <0.0%> (-76.8%) ⬇️
...ml/tests/component_tests/test_xgboost_regressor.py 24.5% <0.0%> (-75.5%) ⬇️
...tests/component_tests/test_polynomial_detrender.py 25.7% <0.0%> (-74.3%) ⬇️
...nent_tests/test_exponential_smoothing_regressor.py 26.9% <0.0%> (-73.1%) ⬇️
...l/tests/component_tests/test_xgboost_classifier.py 23.3% <0.0%> (-69.7%) ⬇️
...nent_tests/test_vowpal_wabbit_binary_classifier.py 31.5% <0.0%> (-68.5%) ⬇️
... and 23 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a604c88...58330e8. Read the comment docs.

fjlanasa added 2 commits March 22, 2022 14:42
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.

Automate Dead Link Detection in Docs

2 participants