diff --git a/.github/workflows/markdown_link_check.yml b/.github/workflows/markdown_link_check.yml index 62b486c..03f19a8 100644 --- a/.github/workflows/markdown_link_check.yml +++ b/.github/workflows/markdown_link_check.yml @@ -24,6 +24,8 @@ jobs: - name: Check links run: | # Generate default configuration file if it doesn't exist. - if [ ! -f .linkspector.yml ] ; then printf "dirs:\n - ./\nignorePatterns:\n - pattern: '^https://www.gnu.org/licenses.*$'\n" > .linkspector.yml ; fi + # - github.com URL's can lead to rate limiting errors. + # - stsci.edu URL's can lead to connection refused errors. + if [ ! -f .linkspector.yml ] ; then printf "dirs:\n - ./\nignorePatterns:\n - pattern: '^https://www.gnu.org/licenses.*$'\n - pattern: '^https://jwst-docs.stsci.edu/$'\n" > .linkspector.yml ; fi # Run the check. linkspector check diff --git a/README.md b/README.md index b34cd03..7ec16a0 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,10 @@ This quote highlights the goal of this repository: [arghwhat](https://news.ycombinator.com/item?id=36354464) > The problem with DevOps is not really how it is practiced, but how it is named. DevOps is a bucket that a bunch of things are thrown into, and everybody thinks the thing they threw in is DevOps with the others being mislabelled. + +## URL's to test the markdown linkchecker action + +These URL's have caused trouble with the markdown link checker, and are +therefore included here: + +- https://jwst-docs.stsci.edu/