.mdox.validate.yaml

version: 1
timeout: "1m"

explicitLocalValidators: true

validators:
  # Skip localhost examples.
  - regex: 'localhost'
    type: "ignore"
  # docs.github.com returns 403 if not in browser. Cannot curl as well.
  - regex: 'docs\.github\.com'
    type: "ignore"
  # Cloudflare protection, so returns 503 if not in browser. Cannot curl as well.
  - regex: 'wise\.com'
    type: "ignore"
  # Adopters example link.
  - regex: "our-link"
    type: "ignore"
  # 301 errors even when curl-ed.
  - regex: "envoyproxy"
    type: "ignore"
  # Ignore release links.
  - regex: 'https:\/\/github\.com\/prometheus-operator\/prometheus-operator\/releases'
    type: "ignore"
  # Ignore GitHub container packages link as it returns 404 in curl, but works in browser
  - regex: 'https://github.com/prometheus-operator/prometheus-operator/pkgs/container/prometheus-operator'
    type: "ignore"
  # Ignore links to /img/ because the generated content will resolve them correctly.
  - regex: '/img/.+'
    type: ignore
  # Twitter changed their policy and now returns 403 if not authenticated. We can guarantee this link since we own the account.
  - regex: 'https:\/\/twitter.com\/PromOperator'
    type: ignore
  # Ignore anchor links pointing to the API documentation which are HTML <a> tags and not supported by mdox.
  - regex: 'api\.md#monitoring\.coreos\.com/v1\.(BasicAuth|PrometheusSpec|StorageSpec)$'
    type: ignore
  # Ignore dead links from Ambassador (soon to be removed).
  - regex: 'getambassador'
    type: ignore
  # Ignore all github.com URLs because of rate limiting.
  # TODO: find an alternative way to check these URLs avoiding the rate limiting.
  - regex: 'github.com'
    type: ignore
  # Ignore all istio.io URLs because of http request timeout.
  - regex: 'istio.io'
    type: ignore
  # Use the githubPullsIssues validator to avoid rate-limiting.
  - regex: '(^http[s]?:\/\/)(www\.)?(github\.com\/)prometheus-operator\/prometheus-operator(\/pull\/|\/issues\/)'
    type: githubPullsIssues
    # The GitHub actions running mdox configure the GITHUB_TOKEN environment variable.
    token: '$(GITHUB_TOKEN)'