.htmltest.yml

CacheExpires: 13300h # ~ 18 months
DirectoryPath: public
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreCanonicalBrokenLinks: false
IgnoreInternalEmptyHash: true # TODO: remove after resolution of https://github.com/google/docsy/issues/1995
CheckMailto: false
TestFilesConcurrently: true
IgnoreDirs:
  # DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
  # Ignore blog index pages for all locales and in all blog sections (top-level and years)
  - ^(../)?blog/(\d+/)?page/\d+
  # Ignore old blog posts
  - ^(../)?blog/20(19|21|22|23)/
  # TODO drop next lines after https://github.com/open-telemetry/opentelemetry.io/issues/5555 is fixed for these pages:
  - ^zh/docs/concepts/signals/baggage/
  - ^zh/docs/zero-code/php/
  # TODO drop the following config once this page is updated to reflect the corresponding `en`
  # page and the link 404 (detailed below) are resolved:
  #   zh/docs/contributing/index.html
  #     Non-OK status: 404 --> https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md
  - ^zh/docs/contributing/
  # DO NOT EDIT! IgnoreDirs list is auto-generated from markdown file front matter.
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
  - /index.xml$ # Ignore rel="alternative" links to RSS feeds
  - ^/api$
  - ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$
  - ^(/..)?/docs/collector/registry/$
  - ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
  - ^((/..)?/docs/migration/)?opencensus/$
  - ^(/community/end-user/)?feedback-survey/$
  - ^/../docs/specs/?$ # non-default locale spec redirect

  - ^https://deploy-preview-\d+--opentelemetry.netlify.app/
  - ^https://www\.googletagmanager\.com
  - ^(https:)?//translate.google.com

  # Don't ignore `:1313` since it is often a docs link copy-paste error, e.g.:
  # https://github.com/open-telemetry/opentelemetry.io/pull/6123
  - ^https?://localhost(:([^1]|16*)|(/.*)?$)
  - ^https?://127\.0\.0\.1\b
  - ^https?://(otel-demo|traefik)\.localhost

  # OpAMP spec:
  - ^https://pdf.sciencedirectassets.com/280203/1-s2.0-S1877050919X0006X/1-s2.0-S1877050919303576/main.pdf\?

  # Sites that deny access, always yielding 401, 403 Forbidden, 406, or other:
  - ^https://platform.openai.com # Really hard to trick into giving a 200 when using a script; manually verify links
  - ^https://star-history.com # link contain ampersands in URL anchor part, which htmltest escapes, so it's not found
  - ^https://twitter.com
  - ^https://www.youtube.com/playlist\?list= # htmltest doesn't process query parameters
  - ^https://x.com

  # Ignore Docsy-generated GitHub links for now, until
  # https://github.com/google/docsy/issues/1432 is fixed
  - ^https?://github\.com/.*?/.*?/(new|edit|issues/new\?title)/ # view-page, edit-source etc
  # Here's an approximate regex to avoid the "View page source" links. TODO: fix this in Docsy
  - ^https?://github\.com/open-telemetry/opentelemetry.io/tree/
  # FIXME: A patch until we can get Docsy to mark "View page source" links as excluded from link checking,
  # Actually, it would be better to pin the version of the OTel spec.
  - ^https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/logs/event-(api|sdk)\.md
  # FIXME: same issue as for the OTel spec mentioned above:
  - ^https://github.com/open-telemetry/semantic-conventions/tree/main

  # Too many redirects as the server tries to figure out the country and language,
  # e.g.: https://www.microsoft.com/en-ca/sql-server.
  - ^https://www.microsoft.com/sql-server$

  # TODO: drop after fix to https://github.com/rust-lang/crates.io/issues/788
  - ^https://crates\.io/crates
  # TODO move into content/en/blog/2023/humans-of-otel.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
  - ^https://shorturl.at/osHRX$
  # TODO move into content/en/blog/2023/contributing-to-otel/index.md once https://github.com/open-telemetry/opentelemetry.io/issues/3889 is implemented
  - ^https://shorturl.at/vLYZ0$